Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename and clean up #110

Closed
johnd0e opened this issue Feb 20, 2019 · 1 comment
Closed

Rename and clean up #110

johnd0e opened this issue Feb 20, 2019 · 1 comment
Labels
development general development issue

Comments

@johnd0e
Copy link
Contributor

johnd0e commented Feb 20, 2019

Currently in the project there are some inaccuracy and inconsistency with naming of files/plugins.

E.g.

  • All highlighters are named as portal-highlighter-....user.js, with 1 exception: show-portal-weakness.user.js
  • Mistypes in portal-highlighter-needs-recharge.user.js, portal-highlighter-forgotten.user.js
    names contain 'hightlight' (#798).
  • Several deleted plugins still has stub-files.
  • max-links.user.js is actually Tidy Links in layer chooser.

We care for stubs and names for 1 reason only: (auto)updating.
But:

So I propose to make some improvements until it's too late.

@johnd0e johnd0e added the development general development issue label Feb 20, 2019
@johnd0e
Copy link
Contributor Author

johnd0e commented Feb 20, 2019

So I'm going to rename some files, change some plugins names and categories, and remove old stubs for deleted plugins.

What is important for updating:

  • Filename, as it is in the @updateURL/@downloadURL
  • @name (and @namespace, but it's consistent for every plugin in this repo)
  • @version (Scripts versioning #99)

What is not important, and can be changed freely:

  • @description
  • @category
  • @id

AFAIK, @id is not used neither in the IITC itself nor in any script manager, so I'm going to get rid of this field completely.

Thoughts?

This was referenced Feb 20, 2019
modos189 added a commit that referenced this issue Mar 14, 2019
Renames

    Remove broken stuff (Fix #25)
    Plugin files renames for more consistency (Fix #110)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development general development issue
Projects
None yet
Development

No branches or pull requests

1 participant