1. Nvda-Addons | Nvda-Addons
  2. Topics

Add-on store: resolving uppercase versus lowercase conflict between legacy and actual add-on names/ID's

Joseph Lee
 

Hi all,

Turns out there are add-ons in add-on store that may not be submitted correctly due to add-on ID case differences. For example, Access8Math is seen as “access8math” in the add-on store whereas the manifest name field says “Access8Math”. Please do let us know if you come across additional examples so they can be resolved as soon as possible.

Cheers,

Joseph
Rui Fontes
 

Joseph, can you see what is necessary to solve the problem of addonsHelp?


Best regards,

Rui Fontes
NVDA portuguese team


Às 22:06 de 13/03/2023, Joseph Lee escreveu:

Hi all,

Turns out there are add-ons in add-on store that may not be submitted correctly due to add-on ID case differences. For example, Access8Math is seen as “access8math” in the add-on store whereas the manifest name field says “Access8Math”. Please do let us know if you come across additional examples so they can be resolved as soon as possible.

Cheers,

Joseph
Joseph Lee
 

Hi,

I’m using WSL to resolve uppercase/lowercase issue by:

  1. Rename addonshelp to something else.
  2. Rename the just renamed folder to addonsHelp.

I can take care of addonshelp for you as I also plan to work on Access8Math as well.

Cheers,

Joseph

 

From: nvda-addons@nvda-addons.groups.io <nvda-addons@nvda-addons.groups.io> On Behalf Of Rui Fontes
Sent: Tuesday, March 14, 2023 9:52 AM
To: nvda-addons@nvda-addons.groups.io
Subject: Re: [nvda-addons] Add-on store: resolving uppercase versus lowercase conflict between legacy and actual add-on names/ID's

 

Joseph, can you see what is necessary to solve the problem of addonsHelp?

 

Best regards,

Rui Fontes
NVDA portuguese team

Às 22:06 de 13/03/2023, Joseph Lee escreveu:

Hi all,

Turns out there are add-ons in add-on store that may not be submitted correctly due to add-on ID case differences. For example, Access8Math is seen as “access8math” in the add-on store whereas the manifest name field says “Access8Math”. Please do let us know if you come across additional examples so they can be resolved as soon as possible.

Cheers,

Joseph
Rui Fontes
 

Thanks!


Best regards,

Rui Fontes
NVDA portuguese team



Às 17:32 de 14/03/2023, Joseph Lee escreveu:

Hi,

I’m using WSL to resolve uppercase/lowercase issue by:

  1. Rename addonshelp to something else.
  2. Rename the just renamed folder to addonsHelp.

I can take care of addonshelp for you as I also plan to work on Access8Math as well.

Cheers,

Joseph

 

From: nvda-addons@nvda-addons.groups.io <nvda-addons@nvda-addons.groups.io> On Behalf Of Rui Fontes
Sent: Tuesday, March 14, 2023 9:52 AM
To: nvda-addons@nvda-addons.groups.io
Subject: Re: [nvda-addons] Add-on store: resolving uppercase versus lowercase conflict between legacy and actual add-on names/ID's

 

Joseph, can you see what is necessary to solve the problem of addonsHelp?

 

Best regards,

Rui Fontes
NVDA portuguese team

Às 22:06 de 13/03/2023, Joseph Lee escreveu:

Hi all,

Turns out there are add-ons in add-on store that may not be submitted correctly due to add-on ID case differences. For example, Access8Math is seen as “access8math” in the add-on store whereas the manifest name field says “Access8Math”. Please do let us know if you come across additional examples so they can be resolved as soon as possible.

Cheers,

Joseph
woody tseng
 

Hello,
 
Besides Joseph's work, what else do I need to do to solve this problem currently?
Thank Joseph's work
 
Woody
Joseph Lee
 

Hi,

For now I advise closing Access8Math 3.5 pull request and create a new one after lowercase to uppercase conversion is done.

Cheers,

Joseph

 

From: nvda-addons@nvda-addons.groups.io <nvda-addons@nvda-addons.groups.io> On Behalf Of woody tseng
Sent: Tuesday, March 14, 2023 5:25 PM
To: nvda-addons@nvda-addons.groups.io
Subject: Re: [nvda-addons] Add-on store: resolving uppercase versus lowercase conflict between legacy and actual add-on names/ID's

 

Hello,

 

Besides Joseph's work, what else do I need to do to solve this problem currently?

Thank Joseph's work

 

Woody
Noelia Ruiz
 

Hi, the same for searchwith. Cheers

Enviado desde mi iPhone

El 15 mar 2023, a las 1:30, Joseph Lee <joseph.lee22590@...> escribió:



Hi,

For now I advise closing Access8Math 3.5 pull request and create a new one after lowercase to uppercase conversion is done.

Cheers,

Joseph

 

From: nvda-addons@nvda-addons.groups.io <nvda-addons@nvda-addons.groups.io> On Behalf Of woody tseng
Sent: Tuesday, March 14, 2023 5:25 PM
To: nvda-addons@nvda-addons.groups.io
Subject: Re: [nvda-addons] Add-on store: resolving uppercase versus lowercase conflict between legacy and actual add-on names/ID's

 

Hello,

 

Besides Joseph's work, what else do I need to do to solve this problem currently?

Thank Joseph's work

 

Woody
Joseph Lee
 

Hi all,

A series of pull requests will be submitted to change the following add-on ID's from lowercase to camel case by standardizing arond actual add-on manifest name field:

  • Access8Math: access8math -> Access8Math
  • Add-ons documentation: addonshelp -> addonsHelp
  • Audio chart: audiochart -> audioChart
  • Beep keyboard: beepkeyboard -> beepKeyboard
  • Console Toolkit: consoletoolkit -> consoleToolkit
  • Direct link: directlink -> directLink
  • Indent Nav: indentnav -> IndentNav
  • Kill NVDA: iillnvda -> killNVDA
  • MathCAT: mathcat -> MathCAT
  • Quick dictionary: quickdictionary -> quickDictionary
  • Search with: searchwith -> searchWith
  • Sentence Nav: sentencenav -> SentenceNav
  • VLC: vlc -> VLC
  • WinWizard: winwizard -> winWizard
  • Word nav: wordnav -> wordNav

For reference, I did:

Best environment: Windows Subsystem for Linux or any tool that can work with file system data and can differentiate cases:

  1. Checkout add-on datastore repo.
  2. Locate add-on ID's which differ by case from manifest name field.
  3. Fetch the latest master branch commit, then create a branch and give it the name you want the add-on to appear under. The branch names I used were of the form "lower2upper-addonName".
  4. Open the latest version json file for the affected add-on ID and change addonID field to match manifest name field or the add-on name part of the download link/nvda-addon file.
  5. Rename folders. This can be done via "git mv oldname newname" in one pass in Linux unless you told Windows to take case into accont; if renaming via Windows, rename the oldname to something else before renaming it to newname.
  6. Make sure you've got everything right (git status), then commit and push.
  7. Submit a manual pull request (via pull requests mechanism) instead of going through add-on submissino process via new issue form.

I will update this thread once all add-on ID's are updated. In the meantime, I vote to close existing pull requests for add-ons listed above.

Cheers,

Joseph
Joseph Lee
 

Hi all,

A Search With add-on update was submitted to add-on store that can cause tracebacks after installing it, traced to a mismatch between add-on ID, manifest name field, package name, and the ad-don name used in NVDA installatoins:

  • Add-onID (current): searchwith
  • Package name: searchWith-version.nvda-addon
  • Manifest name: searchwith (previously searchWith)
  • Folder name inside NVDA installations: searchWith

To avoid issues with other add-ons where conflicts can arise due to lowercase versus uppercase differences, I advise holding off on store submissions for affected add-ons (see an earlier message on list of affected add-ons) until add-on ID's do match add-on manifest name field data. In case of Search With:

  • If the add-on ID is to be searchWith (notice the camel case), then no add-on store submission for this add-on should be attempted (via GitHub issues) UNTIL lowercase to uppercase conversion is complete.
  • If the add-on ID is to be searchwith (all lowercase), no action is necessary from the store side - the add-on author must release a new version to correct this issue and let users know about workarounds (uninstall older versions, restart NVDA, install the correct version, restart NVDA again).

Relevant Search With add-on issue: https://github.com/ibrahim-s/searchWith/issues/10#issuecomment-1476769868

I know there are add-ons that are being queued for distribution on add-on store that can cause possible issues (Access8Math being one of them). This is why I advise holding off on new submissions for affected add-ons until ad-don ID's do match manifest name field.

Cheers,

Joseph
Ibrahim Hamadeh
 

Hi Joseph,
I really prefer to keep with the old camel case style, thing that I have got used to it.
So , as I commented in the issue, I will wait until this problem has been resolved.
Thanks very much

ibrahim


On 3/20/2023 9:50 PM, Joseph Lee wrote:

Hi all,

A Search With add-on update was submitted to add-on store that can cause tracebacks after installing it, traced to a mismatch between add-on ID, manifest name field, package name, and the ad-don name used in NVDA installatoins:

  • Add-onID (current): searchwith
  • Package name: searchWith-version.nvda-addon
  • Manifest name: searchwith (previously searchWith)
  • Folder name inside NVDA installations: searchWith

To avoid issues with other add-ons where conflicts can arise due to lowercase versus uppercase differences, I advise holding off on store submissions for affected add-ons (see an earlier message on list of affected add-ons) until add-on ID's do match add-on manifest name field data. In case of Search With:

  • If the add-on ID is to be searchWith (notice the camel case), then no add-on store submission for this add-on should be attempted (via GitHub issues) UNTIL lowercase to uppercase conversion is complete.
  • If the add-on ID is to be searchwith (all lowercase), no action is necessary from the store side - the add-on author must release a new version to correct this issue and let users know about workarounds (uninstall older versions, restart NVDA, install the correct version, restart NVDA again).

Relevant Search With add-on issue: https://github.com/ibrahim-s/searchWith/issues/10#issuecomment-1476769868

I know there are add-ons that are being queued for distribution on add-on store that can cause possible issues (Access8Math being one of them). This is why I advise holding off on new submissions for affected add-ons until ad-don ID's do match manifest name field.

Cheers,

Joseph
Joseph Lee
 

Hi lal,

Good news: lowercase to uppercase/camel case conversion is complete. Thank you for your patience.

Cheers,

Joseph
Rui Fontes
 

Hi Joseph!


Do I need to do something about addonsHelp?


Best regards,

Rui Fontes
NVDA portuguese team


Às 23:53 de 22/03/2023, Joseph Lee escreveu:

Hi lal,

Good news: lowercase to uppercase/camel case conversion is complete. Thank you for your patience.

Cheers,

Joseph
Joseph Lee
 

Hi,

I advise closing the existing issue, then recreate it so the new file path can be applied.

Cheers,

Joseph

From: nvda-addons@nvda-addons.groups.io <nvda-addons@nvda-addons.groups.io> On Behalf Of Rui Fontes
Sent: Wednesday, March 22, 2023 4:55 PM
To: nvda-addons@nvda-addons.groups.io
Subject: Re: [nvda-addons] Add-on store: resolving uppercase versus lowercase conflict between legacy and actual add-on names/ID's

 

Hi Joseph!

 

Do I need to do something about addonsHelp?

 

Best regards,

Rui Fontes
NVDA portuguese team

Às 23:53 de 22/03/2023, Joseph Lee escreveu:

Hi lal,

Good news: lowercase to uppercase/camel case conversion is complete. Thank you for your patience.

Cheers,

Joseph
Joseph Lee
 

Hi,

Looks like Sean has merged Add-ons Help pull request sent earlire, so there is no need for another pull request. Thanks.

Cheers,

Joseph
Rui Fontes
 

Thanks!


Best regards,

Rui Fontes
NVDA portuguese team


Às 00:25 de 23/03/2023, Joseph Lee escreveu:

Hi,

Looks like Sean has merged Add-ons Help pull request sent earlire, so there is no need for another pull request. Thanks.

Cheers,

Joseph
Joseph Lee
 

Hi,

Important update: looks like I spoke too soon- there are add-on ID's that are still undergoing conversion process.

Cheers,

Jsoeph

1 - 16 of 16