Update from template repo: PRs 15, 24, 26 #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Install and configure storybook, sass, and USWDS 3.0 [#15](navapbc/template-application-nextjs#15) - Install and configure storybook - Create the first story - Install and configure [USWDS 3.0](https://designsystem.digital.gov/) as the design system - Modify `Dockerfile` and `docker-compose.yml` to support USWDS and storybook - Gitignore storybook, uswds assets, and compiled css - Prettier ignore uswds assets - Use postinstall hook to copy uswds static assets - Stop using CSS modules - Update some package dependencies - Switch Docker base image to use alpine for increased speed
Setup i18n for next.js, jest, and storybook [#24](navapbc/template-application-nextjs#24) - Install and configure [next-i18next](https://github.com/i18next/next-i18next) for Next.js internationalization - Move next.js i18n config out of `next.config.js` and into `next-i18next.config.js` - Modify `pages/_app.tsx` and `pages/index.tsx` to support i18n - Move jest i18n config into `/tests/jest-i18n.ts` - Install and configure [storybook-react-i18next](https://storybook.js.org/addons/storybook-react-i18next) for storybook internationalization - Add support for `<em>` tags in react-i18next in both next.js and storybook. Extras: - Remove `space-before-function-paren` eslint rule - Update eslint to follow prettier's rules - Rename `test` dir to `tests` (plural)
Adds a src dir, layout component, alphabetizes imports [#26](navapbc/template-application-nextjs#26) - adds `src/` directory for project's webpack compilable JS and JSON files (this update is supported out of the box by [NextJS](https://nextjs.org/docs/advanced-features/src-directory) and pfml also uses this folder structure) - moves `api/`, `pages/` and `messages/` directories to `src/` - creates `components` directory and adds template `Layout` component Extras: - sets up prettier alphabetize imports - adds storybook-static to prettier ignore - sets $theme-show-compile-warnings to true for uswds
Enable dependabot version updates and codeql security scanning as CI jobs [#29](navapbc/template-application-nextjs#29) - Enable and configure [dependabot version updates](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates) - Enable and configure [codeql security scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) Note: These features were already enabled in this repo, so this commit is just bringing in stylistic updates to make the two repos identical.
Add layout styles missing from PR #26. [#37](navapbc/template-application-nextjs#37)
aplybeah
reviewed
Jul 19, 2022
Comment on lines
-59
to
-60
| - "space-before-function-paren": ["error", "never"] | ||
| - suppresses errors for lack of space before function parenthesis to allow for `function()` |
There was a problem hiding this comment.
Why was this removed? Is it no longer needed?
There was a problem hiding this comment.
I went with the opposite approach:
disabling style lint rules and using whatever the code formatter's default is
See discussion.
aplybeah
reviewed
Jul 19, 2022
|
|
||
| We are using the [USWDS 3.0](https://designsystem.digital.gov) design system. | ||
|
|
||
| We did not follow their [install directions](https://designsystem.digital.gov/documentation/getting-started/developers), which require using gulp as a task runner. Instead, we configured `next.config.js` such that we could leverage Next.js's built-in sass compiling and we configured `.storybook/main.js` such that we could leverage Storybook's built-in sass compiling and re-use the same Next.js configuration. |
There was a problem hiding this comment.
Thanks for putting this in the README. Were you able to narrow down why the initial compile is so slow?
There was a problem hiding this comment.
Nope. It's still very slow 😞
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket
N/A
Changes
This will also close: