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

Move shield library into new repository #889

Open
6 tasks
claysmalley opened this issue Jun 29, 2023 · 3 comments
Open
6 tasks

Move shield library into new repository #889

claysmalley opened this issue Jun 29, 2023 · 3 comments
Labels
enhancement New feature or request shield-generator Issues specific to the shield library

Comments

@claysmalley
Copy link
Member

claysmalley commented Jun 29, 2023

The shield generator has taken on a life of its own. Now that it's a separate codepath and published as an NPM package, it should be given its own repository. This will make it simpler to track issues and reuse the code in other projects.

  • Determine more compact format for shields.json
  • Check in shields.json, remove shield_defs.js
  • Transfer code, issues and history to new repository
  • Reconfigure Github, NPM
  • Transition repository to new organization
  • Remove shieldlib/
@claysmalley claysmalley added enhancement New feature or request shields labels Jun 29, 2023
@ZeLonewolf
Copy link
Member

Thanks for writing this up. I support this initiative. I think we should also extend the work in the pending #881 to also report on the size of the shields.json file so we have a metric for compactness. After all, the download time of that file is part of the overall map load time.

@ZeLonewolf ZeLonewolf added shield-generator Issues specific to the shield library and removed shields labels Jul 3, 2023
@adamfranco
Copy link
Collaborator

Another benefit of this move is easier filtering/monitoring of issues -- shields significantly dominate the issue queue and not all interested in Americana are as engaged on the topic. 😉

@ZeLonewolf
Copy link
Member

To be fair, most of the shield traffic is on the design side which would still be in this repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request shield-generator Issues specific to the shield library
Projects
None yet
Development

No branches or pull requests

3 participants