Skip to content

Conversation

@ovflowd
Copy link
Member

@ovflowd ovflowd commented Apr 18, 2023

This PR updates the ESLint rules and enforces common consistencies that are easily missed.

This PR also updates the CONTRIBUTING guidelines by adding and enforcing a few new sections across the codebase.

New ESLint rules

  • Enforce import type
  • Ban import React default import
  • Ban import * as React namespace import
  • Enforce ordering of imports
  • Enforce destructuring of Component props
  • Enforce usage of type over interface on React Components

Updated Contributing Guidelines

  • Added a new section for Unit Tests and Storybooks
  • Added a new section on how React Components should be coded
  • This PR also updates all Storybooks to follow the template

IMPORTANT NOTE: Most of the file changes of this PR are ESLint applying these new rules. No actual code change was done here.

@ovflowd ovflowd requested a review from a team as a code owner April 18, 2023 22:11
@ovflowd
Copy link
Member Author

ovflowd commented Apr 18, 2023

Hey, @nodejs/website, this PR changes our CONTRIBUTING guidelines; hence fast-tracking cannot be applied here.

I request all of you to give a nice review of these changes. Thank you!

@ovflowd ovflowd added the website redesign Issue/PR part of the Node.js Website Redesign label Apr 18, 2023
@ovflowd ovflowd changed the title chore(stories): made stories consistent chore: updated contributing guidelines, eslint rules and storybook templates Apr 18, 2023
@vercel
Copy link

vercel bot commented Apr 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 20, 2023 9:07am
nodejs-org-stories ✅ Ready (Inspect) Visit Preview Apr 20, 2023 9:07am

ovflowd and others added 2 commits April 19, 2023 19:50
Co-authored-by: Shanmughapriyan S <[email protected]>
Signed-off-by: Claudio Wunder <[email protected]>
@ovflowd ovflowd requested a review from shanpriyan April 19, 2023 17:51
@vercel vercel bot temporarily deployed to Preview April 19, 2023 17:58 Inactive
Co-authored-by: Manish Kumar ⛄ <[email protected]>
Signed-off-by: Claudio Wunder <[email protected]>
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 07:30 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org April 20, 2023 07:36 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 07:46 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org April 20, 2023 07:46 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org April 20, 2023 08:00 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 08:01 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org April 20, 2023 08:29 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 08:34 Inactive
@ovflowd
Copy link
Member Author

ovflowd commented Apr 20, 2023

@nodejs/website can we get reviews? I wanted to merge this asap as tomorrow I'll be doing a workshop and would like to have these new changes merged by then!

(Pretty much requesting fast-tracking here as I want to have this PR to get merged before we start on other work)

@vercel vercel bot temporarily deployed to Preview – nodejs-org April 20, 2023 09:06 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories April 20, 2023 09:07 Inactive
@ovflowd ovflowd added the fast-track Fast Tracking PRs label Apr 20, 2023
@ovflowd ovflowd merged commit bfcabb9 into nodejs:major/website-redesign Apr 20, 2023
@ovflowd ovflowd deleted the chore/normalise-stories-remove-old-stories branch April 20, 2023 12:01
ovflowd added a commit that referenced this pull request May 3, 2023
…mplates (#5294)

Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Manish Kumar ⛄ <[email protected]>
ovflowd added a commit that referenced this pull request May 14, 2023
* feat(unit-test): introduce unit test on website redesign branch (#5178

feat(unit-test): introduce unit test

* chore(minor): just a tiny design nitpick

* chore: set up storybook (#5191) (#5214)

* chore: set up testing-library jest extend (#5231)

Co-authored-by: Manish Kumar ⛄ <[email protected]>

* chore(dependencies): updated dependencies

* feat: create section title component (#5237)

Co-authored-by: Wai.Tung <[email protected]>

* 📎 chore(migration): migrate banner component (#5233)

Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Michael Esteban <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>

* feat: migrate AnimatedPlaceholder component (#5238

Migrate AnimatedPlaceholder component from nodejs.dev
and create a new Story.

* feat: create article alert component (#5243)

* feat: migrate blockquote component (#5259)

* feat(stylelint,storybook): fixed styleling misconfig and fixed storybooks (#5281)

* feat: create article data tag component (#5280)

* feat: migrate AuthorList component and add story 🎉 (#5277)

Co-authored-by: Michael Esteban <[email protected]>

* chore(migration): migrate language selector component (#5266)

Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]>
Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Michael Esteban <[email protected]>

* feat(DarkModeToggler): Migrate and add stories to theme toggler 🎉 (#5236)

Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>

* chore: updated contributing guidelines, eslint rules and storybook templates (#5294)

Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Manish Kumar ⛄ <[email protected]>

* chore: contributing quick fix of example

Signed-off-by: Claudio Wunder <[email protected]>

* chore: story guide and react spreading

Signed-off-by: Claudio Wunder <[email protected]>

* chore: remove base styles from old styling

* chore: fix storybook styles, imports, typescript config and dependencies (#5319

* chore: optimises tsconfig

* chiore: add missing dependencies

* chore: type storybook constants

* chore: styles moved styles to somewhere else

* chore: add global json type definition

* chore: i18n aria-label instead of sr-only

* chore: added open sans font family and space between imports

* chore: moved styles and fixed styles and updated banner stories

* fix: stylelint rules

* chore: updated tsconfig

* chore: fix tests

* fix: darkmodetoggle test

* chore: stories use index.stories.tsx

* chore: adopt turborepo (#5316

* chore: revert pnpm use plain npm

* fix: package.json

* chore: remove warnings and add node_env

* chore: cross-env

* fix: fix turbo pipelines

* chore: only cache certain files

* chore: turbo shouldn't care about coverage outputs

* chore: proper inputs and outputs for pipelines

* chore: do not store some outputs and updated inputs for lint

* chore: added prettier configs

* chore: remove console.info

* chore: updated inputs of all other entries

* fix(package.json) Lint command is missing slashes (#5321

fix(package.json) lint:fix missing slashes

* moved `DataTag` to `components/Api` (#5317)

Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com>
Co-authored-by: Shanmughapriyan S <[email protected]>

* hot-fix: dependency updates and fix dev runtime

* chore: updated start command

* migration(Layout): newFooter (#5320)

Co-authored-by: Claudio Wunder <[email protected]>

* feat: migrate EditLink component (#5271)

Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Wai.Tung <[email protected]>

* feat(blog) Migrate BlogCard component (#5323)

Co-authored-by: Michael Esteban <[email protected]>

* Issue#5307 - Add framer-motion to the dependency list (#5318)

* chore: add remote turbo cache and simplified gh actions cache (#5326)Co-authored-by: Aymen Naghmouchi <[email protected]>

* chore: add remote turbo cache and simplified gh actions cache

* chore: updated cache rules

* chore: more cache rules

---------

Co-authored-by: Aymen Naghmouchi <[email protected]>

* chore: fix storybook local development mode (#5335)

* chore: migrate pagination component (#5331)

Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Wai.Tung <[email protected]>

* Chore(node feat) (#5338)

Co-authored-by: Claudio Wunder <[email protected]>

* chore: migrate releases types (#5324)

* hotfix: first element no margin-top

* (website redesign) Feat(shellbox): migration (#5234)

Co-authored-by: Manish Kumar ⛄ <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Michael Esteban <[email protected]>
Co-authored-by: Wai.Tung <[email protected]>

* fix(i18n): translation key (#5347)

Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>

* chore: updated dependencies

* chore: vercel enable middleware and i18n redirection (#5300)

* feat(unit-test): introduce unit test on website redesign branch (#5178

feat(unit-test): introduce unit test

* chore: set up storybook (#5191) (#5214)

* feat(stylelint,storybook): fixed styleling misconfig and fixed storybooks (#5281)

* feat(DarkModeToggler): Migrate and add stories to theme toggler 🎉 (#5236)

Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>

* chore: updated contributing guidelines, eslint rules and storybook templates (#5294)

Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Manish Kumar ⛄ <[email protected]>

* chore: fix storybook styles, imports, typescript config and dependencies (#5319

* chore: optimises tsconfig

* chiore: add missing dependencies

* chore: type storybook constants

* chore: styles moved styles to somewhere else

* chore: add global json type definition

* chore: i18n aria-label instead of sr-only

* chore: added open sans font family and space between imports

* chore: moved styles and fixed styles and updated banner stories

* fix: stylelint rules

* chore: updated tsconfig

* chore: fix tests

* fix: darkmodetoggle test

* chore: stories use index.stories.tsx

* chore: adopt turborepo (#5316

* chore: revert pnpm use plain npm

* fix: package.json

* chore: remove warnings and add node_env

* chore: cross-env

* fix: fix turbo pipelines

* chore: only cache certain files

* chore: turbo shouldn't care about coverage outputs

* chore: proper inputs and outputs for pipelines

* chore: do not store some outputs and updated inputs for lint

* chore: added prettier configs

* chore: remove console.info

* chore: updated inputs of all other entries

* feat(stability): migrate component

* chore(snapshot): update

* Update components/Api/Stability/index.tsx

Co-authored-by: Claudio Wunder <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>

* Update components/Api/Stability/index.tsx

Co-authored-by: Claudio Wunder <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>

* Update components/Api/Stability/index.tsx

Co-authored-by: Claudio Wunder <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>

* fea(stability): update stories + fix

* Update components/Api/Stability/index.stories.tsx

Co-authored-by: Claudio Wunder <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>

* fix(i18n): update turkish language direction (#5182)

* chore: rollback CODEOWNER changes (#5183)

* Sync: merge `major/website-redesign` into `main` (#5356)

Co-authored-by: Manish Kumar ⛄ <[email protected]>
Co-authored-by: Wai.Tung <[email protected]>
Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Michael Esteban <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com>
Co-authored-by: Aymen Naghmouchi <[email protected]>
Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]>
Co-authored-by: Augustin Mauroy <[email protected]>
Co-authored-by: Guilherme Araújo <[email protected]>
Co-authored-by: Augustin Mauroy <[email protected]>
Co-authored-by: HinataKah0 <[email protected]>
Co-authored-by: Olaleye Blessing <[email protected]>
Co-authored-by: ktssr <[email protected]>
Co-authored-by: Harkunwar Kochar <[email protected]>
Co-authored-by: vasanthkumar <[email protected]>
Co-authored-by: Floran Hachez <[email protected]>
Co-authored-by: Jatin <[email protected]>

* feat(stability): update snapshot

* Update components/Api/Stability/index.tsx

Co-authored-by: Jithil P Ponnan <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>

* code format

* Update components/Api/Stability/index.tsx

Co-authored-by: Jithil P Ponnan <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>

---------

Signed-off-by: Claudio Wunder <[email protected]>
Signed-off-by: Augustin Mauroy <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Guilherme Araújo <[email protected]>
Co-authored-by: Manish Kumar ⛄ <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]>
Co-authored-by: Wai.Tung <[email protected]>
Co-authored-by: Shanmughapriyan S <[email protected]>
Co-authored-by: Michael Esteban <[email protected]>
Co-authored-by: HinataKah0 <[email protected]>
Co-authored-by: Olaleye Blessing <[email protected]>
Co-authored-by: ktssr <[email protected]>
Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]>
Co-authored-by: Harkunwar Kochar <[email protected]>
Co-authored-by: vasanthkumar <[email protected]>
Co-authored-by: Jatin <[email protected]>
Co-authored-by: Aymen Naghmouchi <[email protected]>
Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]>
Co-authored-by: Yagiz Nizipli <[email protected]>
Co-authored-by: Nick Schonning <[email protected]>
Co-authored-by: Floran Hachez <[email protected]>
Co-authored-by: Jithil P Ponnan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fast-track Fast Tracking PRs website redesign Issue/PR part of the Node.js Website Redesign

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants