Noodlestan's opinionated style guide configuration (ESLint + Prettier).
We are an open collective of people dedicated to the design and software crafts: UX, design, code, web, 3d, audio, the works. Learn more about us and our projects at Noodlestan.org.
👐 Your contribution is welcome! 👐
If would like to share your ideas, report a bug, ask for improvements - or simply say hi! 👋 - don't hesitate to join us on Noodlestan's Discord or to drop us a line at hello@noodlestan.org.
This style guide targets Noodlestan's web stack, mostly based on Solid JS and Astro / Starlight for documentation and sandboxes.
The style guide was built on top of:
We use eslint-config-standard as a base for all JS/TS(X) linting and formatting.
And a few more plugins:
- eslint-plugin-import - automate order of import statements
- eslint-plugin-jsx-a11y - accessibility rules
- eslint-plugin-mdx - parser and rules for MDX files
- eslint-plugin-solid - SolidJS specific rules
- eslint-config-prettier - disables rules that would otherwise conflict with Prettier
- eslint-plugin-prettier - runs prettier as an ESLint rule
Our overrides can be found in src/config.
System requirements:
We recommended using VS Code with the following extensions: ESLint, Prettier, MDX, SpellRight.
First make sure you are using the correct node version by running nvm use.
Install dependencies with npm install.
Run npm run lint. It will lint the example files provided.
- Lefthook - manages the git hooks
Make sure the pre-commit hook was executed. It runs automatically before every commit and lints all code. Under the hood it runs npm run lint and npm run ci. Run these to inspect details of eventual errors.
Copyright (c) 2024 Noodlestan.
Published under a MIT license.