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

Templates: Adding descriptions to package.json, making config files consistant #1346

Merged
merged 2 commits into from
Oct 18, 2020

Conversation

melissamcewen
Copy link
Contributor

Changes

Re: issue #1189

  • Adds description to every template package.json
  • Refactors all config files in templates to snowpack.config.js with a consistent format

Testing

Local tests ran and passed, one snapshot was updated

Docs

No major changes that need explaining

@vercel
Copy link

vercel bot commented Oct 17, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/pikapkg/snowpack/158egh46l
✅ Preview: https://snowpack-git-template-refactor.pikapkg.vercel.app

@stramel
Copy link
Contributor

stramel commented Oct 17, 2020

Would it be worth maintaining links to the respective sections in the docs for the configs? ie.

"installOptions": {
  /** @see https://www.snowpack.dev/#config.installoptions */
},

or maybe just at the top adding a doc block with a link to the configuration section of the docs? ie.

/**
 * _insert some disclaimer here / note about more information on the config_
 * @see https://www.snowpack.dev/#configuration
 */
module.exports = {
  install: [
    /* ... */
  ],
  // ...

@FredKSchott
Copy link
Owner

That's a great idea, although since we're looking to move to a multi-page docs site soon I'd rather wait until that's done before adding links, since they'd almost certainly change. Find-and-replace is also easy tho, so I guess I'm 🤷

Copy link
Owner

@FredKSchott FredKSchott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall! left 2 small comments

Copy link
Owner

@FredKSchott FredKSchott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@melissamcewen melissamcewen merged commit 7d6e9fd into master Oct 18, 2020
@melissamcewen melissamcewen deleted the template-refactor branch October 18, 2020 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants