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

align assets and build output directory naming conventions #1219

Open
4 tasks
thescientist13 opened this issue Apr 13, 2024 · 0 comments
Open
4 tasks

align assets and build output directory naming conventions #1219

thescientist13 opened this issue Apr 13, 2024 · 0 comments
Labels
breaking CLI documentation Greenwood specific docs enhancement Improve something existing (e.g. no docs, new APIs, etc) RFC Proposal and changes to workflows, architecture, APIs, etc
Milestone

Comments

@thescientist13
Copy link
Member

thescientist13 commented Apr 13, 2024

Summary

Coming out of #1199 / #1215, now that Greenwood can automatically bundle more and more static assets (pretty soon we will plan on having an <img> optimization step too!) it started to make "claiming" the assets/ directory a little more "greedy" on Greenwood's part. Generally, most project's in the space, if having an "auto copying" directory tend to call it public/ instead.

However, our current output folder name is public, so we will probably want to change that as well, likely to something call build/ or dist/.

Details

  1. Rename assets/ to public/ - https://github.com/ProjectEvergreen/greenwood/blob/master/packages/cli/src/plugins/copy/plugin-copy-assets.js#L8
  2. Rename output directory to build - https://github.com/ProjectEvergreen/greenwood/blob/master/packages/cli/src/lifecycles/context.js#L12
  3. Update documentation - https://www.greenwoodjs.io/docs/css-and-images/#assets
  4. This might also require updating some build scripts and / or test cases that might have the hardcoded
@thescientist13 thescientist13 added enhancement Improve something existing (e.g. no docs, new APIs, etc) good first issue Good for newcomers RFC Proposal and changes to workflows, architecture, APIs, etc documentation Greenwood specific docs CLI breaking v0.31.0 labels Apr 13, 2024
@thescientist13 thescientist13 added this to the 1.0 milestone Apr 13, 2024
@thescientist13 thescientist13 changed the title align assets directory and build output directory naming conventions align assets and build output directory naming conventions Apr 13, 2024
@thescientist13 thescientist13 moved this from 🔖 Ready to ➡ DEFERRED in [Greenwood] Phase 9 - Standards and Conventions Aug 10, 2024
@thescientist13 thescientist13 removed the good first issue Good for newcomers label Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking CLI documentation Greenwood specific docs enhancement Improve something existing (e.g. no docs, new APIs, etc) RFC Proposal and changes to workflows, architecture, APIs, etc
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant