ultracite 3.2.1

package/README.md

@@ -0,0 +1,152 @@
+<img src="./logo.svg" width="96" height="96" style="width: 96px; height: 96px;" alt="">
+
+<br />
+
+# Ultracite
+
+Ultracite is a robust linting preset for modern TypeScript apps. It's comprised of configuration files for [ESLint](https://eslint.org/), [Prettier](https://prettier.io/) and [Stylelint](https://stylelint.io/). It is incredibly opinionated and strict, enforcing the maximum amount of type safety and code quality through ESLint rules and TypeScript compiler options. It is designed for [Next.js](https://nextjs.org/) apps, but can be used with any TypeScript project, such as [React Native](https://reactnative.dev/) or [Node.js](https://nodejs.org/).
+
+<img src="https://img.shields.io/github/actions/workflow/status/haydenbleasel/ultracite/push.yaml" alt="" />
+
+<img src="https://img.shields.io/npm/dy/ultracite" alt="" />
+
+<img src="https://img.shields.io/npm/v/ultracite" alt="" />
+
+<img src="https://img.shields.io/github/license/haydenbleasel/ultracite" alt="" />
+
+## Features
+
+By default, Ultracite combines with pre-defined rulesets for [ESLint](https://eslint.org/), as well as:
+
+- [Import](https://www.npmjs.com/package/eslint-plugin-import)
+- [jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y)
+- [React](https://www.npmjs.com/package/eslint-plugin-react)
+- [React Hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)
+- [jest](https://www.npmjs.com/package/eslint-plugin-jest)
+- [promise](https://www.npmjs.com/package/eslint-plugin-promise)
+- [n](https://www.npmjs.com/package/eslint-plugin-n)
+- [Typescript](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
+- [Prettier](https://www.npmjs.com/package/eslint-plugin-prettier)
+- [Tailwind](https://github.com/tailwindlabs/prettier-plugin-tailwindcss)
+- [Stylelint](https://stylelint.io/)
+- [Stylelint-Prettier](https://www.npmjs.com/package/stylelint-prettier)
+- [Next.js](https://nextjs.org/docs/basic-features/eslint#eslint-plugin)
+- [Cypress](https://www.npmjs.com/package/eslint-plugin-cypress)
+
+## Installation
+
+Run the command below to install Ultracite with peer dependencies:
+
+```sh
+pnpm add -D ultracite eslint@8 prettier stylelint typescript jest
+```
+
+If you're running [VS Code](https://code.visualstudio.com/), ensure you have the following extensions installed:
+
+```sh
+code --install-extension dbaeumer.vscode-eslint
+code --install-extension esbenp.prettier-vscode
+code --install-extension bradlc.vscode-tailwindcss
+code --install-extension stylelint.vscode-stylelint
+```
+
+## Setup
+
+Create an `eslint.config.mjs` with the following contents:
+
+```js
+import ultracite from 'ultracite';
+
+export default ultracite;
+```
+
+Add the following to your `package.json`:
+
+```json
+{
+  "prettier": "ultracite/prettier",
+  "stylelint": {
+    "extends": "ultracite/stylelint"
+  }
+}
+```
+
+Ultracite is designed to be used with [VS Code](https://code.visualstudio.com/), and includes a `.vscode/settings.json` file that enables full formatting on save. Create a `.vscode/settings.json` file with the following contents:
+
+```json
+{
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true,
+  "emmet.showExpandedAbbreviation": "never",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.esbenp.prettier-vscode": "explicit",
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "eslint.useFlatConfig": true,
+  "eslint.options": {
+    "overrideConfigFile": "eslint.config.mjs"
+  }
+}
+```
+
+Lastly, ensure your `tsconfig.json` (if it exists) includes your new ESLint config and that `strictNullChecks` is enabled.
+
+```json
+{
+  "compilerOptions": {
+    "strictNullChecks": true
+  },
+  "include": ["eslint.config.mjs"]
+}
+```
+
+## Usage
+
+Once Ultracite is set up, it will automatically format your code on save.
+
+## Configuration
+
+You can opt-out of certain rules by modifying your `eslint.config.mjs` file. For example, here's a common exception I use to avoid linting [shadcn/ui](https://ui.shadcn.com/) components:
+
+```js
+import ultracite from 'ultracite';
+
+ultracite.forEach((config) => {
+  if (config.ignores) {
+    config.ignores.push('./components/ui/**/*');
+  } else {
+    config.ignores = ['./components/ui/**/*'];
+  }
+});
+
+export default ultracite;
+```
+
+## Debugging
+
+If you're having issues with Ultracite, you can open the ESLint Output panel in VS Code to see what's going on. Optimally, it should look something like this:
+
+```
+[Info  - 10:42:49 PM] ESLint server is starting.
+[Info  - 10:42:49 PM] ESLint server running in node v18.15.0
+[Info  - 10:42:49 PM] ESLint server is running.
+[Info  - 10:42:50 PM] ESLint library loaded from: /Users/haydenbleasel/GitHub/ultracite/node_modules/.pnpm/eslint@8.51.0/node_modules/eslint/lib/unsupported-api.js
+```
+
+If you see any errors, it could be related to peer dependencies or changes in dependency versions. Feel free to report these as issues.
+
+## Roadmap
+
+- https://github.com/SonarSource/eslint-plugin-sonarjs
+- https://github.com/BenoitZugmeyer/eslint-plugin-html
+- https://github.com/ota-meshi/eslint-plugin-yml
+- https://github.com/mdx-js/eslint-mdx/tree/master/packages/eslint-plugin-mdx
+- https://github.com/eslint/eslint-plugin-markdown
+- https://github.com/amilajack/eslint-plugin-compat
+- https://github.com/sindresorhus/eslint-plugin-unicorn

package/SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+
+Currently, only the latest on `main` branch is supported with security updates.
+
+## Reporting a Vulnerability
+
+To report a vulnerability, open a new issue or DM me on [Twitter / X](https://twitter.com/haydenbleasel).

package/eslint.config.mjs

@@ -0,0 +1,173 @@
+/* eslint-disable n/no-extraneous-import, import/no-extraneous-dependencies, id-length */
+
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import typescript from '@typescript-eslint/eslint-plugin';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import * as importPlugin from 'eslint-plugin-import';
+import jest from 'eslint-plugin-jest';
+import promise from 'eslint-plugin-promise';
+import n from 'eslint-plugin-n';
+import next from '@next/eslint-plugin-next';
+import globals from 'globals';
+import prettier from 'eslint-plugin-prettier';
+import cypress from 'eslint-plugin-cypress';
+import storybook from 'eslint-plugin-storybook';
+import unusedImports from 'eslint-plugin-unused-imports';
+// import tailwindcss from 'eslint-plugin-tailwindcss';
+import * as importTypescriptResolver from 'eslint-import-resolver-typescript';
+
+import eslintPrettier from 'eslint-config-prettier';
+import * as typescriptParser from '@typescript-eslint/parser';
+
+import eslintRules from './rules/eslint.mjs';
+import reactRules from './rules/react.mjs';
+import reactHooksRules from './rules/reactHooks.mjs';
+import typescriptRules from './rules/typescript.mjs';
+import jsxA11yRules from './rules/jsx-a11y.mjs';
+import importRules from './rules/import.mjs';
+import jestRules from './rules/jest.mjs';
+import promiseRules from './rules/promise.mjs';
+import nRules from './rules/n.mjs';
+import nextRules from './rules/next.mjs';
+import prettierRules from './rules/prettier.mjs';
+import eslintTypescriptRules from './rules/eslint-typescript.mjs';
+import cypressRules from './rules/cypress.mjs';
+import storybookRules from './rules/storybook.mjs';
+// import tailwindcssRules from './rules/tailwindcss.mjs';
+import unusedImportsRules from './rules/unused-imports.mjs';
+
+// Patch AudioWorkletGlobalScope
+const browserGlobals = { ...globals.browser };
+delete browserGlobals['AudioWorkletGlobalScope '];
+
+const config = [
+  importPlugin.configs.typescript,
+  {
+    languageOptions: {
+      sourceType: 'module',
+      globals: {
+        ...browserGlobals,
+        ...globals.node,
+      },
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    files: [
+      '**/*.js',
+      '**/*.jsx',
+      '**/*.ts',
+      '**/*.tsx',
+      '**/*.json',
+      '**/*.mjs',
+      '**/*.cjs',
+    ],
+    plugins: {
+      prettier,
+      react,
+      'react-hooks': reactHooks,
+      'jsx-a11y': jsxA11y,
+      import: importPlugin,
+      promise,
+      n,
+      '@next/next': next,
+      'unused-imports': unusedImports,
+      // tailwindcss,
+    },
+    rules: {
+      ...eslintRules,
+      ...reactRules,
+      ...reactHooksRules,
+      ...jsxA11yRules,
+      ...importRules,
+      ...promiseRules,
+      ...nRules,
+      ...nextRules,
+      ...prettierRules,
+      ...eslintPrettier.rules,
+      ...unusedImportsRules,
+      // ...tailwindcssRules,
+    },
+
+    settings: {
+      react: {
+        version: 'detect',
+      },
+
+      // https://github.com/import-js/eslint-plugin-import/issues/2556#issuecomment-1419518561
+      'import/parsers': {
+        espree: ['.js', '.cjs', '.mjs', '.jsx', '.ts', '.tsx'],
+      },
+      'import/resolver': {
+        typescript: true,
+        node: true,
+      },
+    },
+  },
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    languageOptions: {
+      parser: typescriptParser,
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': typescript,
+      'import/typescript': importTypescriptResolver,
+    },
+    rules: {
+      ...eslintTypescriptRules,
+      ...typescriptRules,
+    },
+  },
+  {
+    files: ['**/*.test.js', '**/*.test.jsx', 'tests/**/*.js', 'tests/**/*.jsx'],
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+      },
+    },
+    plugins: {
+      jest,
+    },
+    rules: {
+      ...jestRules,
+    },
+  },
+  {
+    files: ['**/*.cy.js', '**/*.cy.jsx'],
+    languageOptions: {
+      globals: {
+        ...globals.cypress,
+      },
+    },
+    plugins: {
+      cypress,
+    },
+    rules: {
+      ...cypressRules,
+    },
+  },
+  {
+    files: [
+      '**/*.stories.js',
+      '**/*.stories.jsx',
+      '**/*.stories.ts',
+      '**/*.stories.tsx',
+    ],
+    plugins: {
+      storybook,
+    },
+    rules: {
+      ...storybookRules,
+    },
+  },
+];
+
+export default config;

package/license.md

@@ -0,0 +1,7 @@
+Copyright (c) 2022 — Present Hayden Bleasel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/logo.svg

@@ -0,0 +1 @@
+<svg fill="none" height="118" viewBox="0 0 791 118" width="791" xmlns="http://www.w3.org/2000/svg"><g fill="#000"><path d="m73.4415 3.08447-11.5112-3.08447-9.7007 36.2036-8.7579-32.68485-11.5116 3.08447 9.4625 35.31358-23.5687-23.5686-8.42691 8.4269 25.85191 25.8521-32.19444-8.6265-3.08446 11.5112 35.1764 9.4256c-.4027-1.7371-.6158-3.5471-.6158-5.4068 0-13.1637 10.6713-23.8349 23.835-23.8349s23.8349 10.6712 23.8349 23.8349c0 1.8477-.2104 3.6466-.6082 5.3734l31.9687 8.566 3.084-11.5113-35.3158-9.463 32.1968-8.6271-3.085-11.5112-35.3147 9.4624 23.5686-23.5684-8.4269-8.42693-25.4933 25.49343z"/><path d="m81.5886 65.0381c-.9869 4.1725-3.0705 7.9209-5.9294 10.9241l23.16 23.1603 8.4268-8.4269z"/><path d="m75.4254 76.2044c-2.8935 2.9552-6.55 5.1606-10.6505 6.297l8.4275 31.4516 11.5113-3.084z"/><path d="m64.345 82.6165c-1.9025.4891-3.8965.749-5.9514.749-2.2016 0-4.3335-.2985-6.3574-.8573l-8.4351 31.4808 11.5112 3.084z"/><path d="m51.6292 82.3922c-4.0379-1.193-7.6294-3.4264-10.4637-6.3902l-23.217 23.2171 8.4269 8.4269z"/><path d="m40.9741 75.7968c-2.7857-2.9824-4.8149-6.6808-5.7807-10.7889l-32.07328 8.5941 3.08444 11.5112z"/><path d="m230.886 72.7605c0 23.184-12.144 36.9835-33.81 36.9835s-33.81-13.7995-33.81-36.9835v-63.342h16.422v64.722c0 12.834 5.796 20.424 17.388 20.424s17.388-7.59 17.388-20.424v-64.722h16.422zm6.294 20.562h24.84v-61.548c0-5.52-2.484-8.004-7.728-8.004h-17.112v-14.21401h17.112c15.456 0 23.736 7.59001 23.736 22.21801v61.548h22.08v14.2135h-62.928zm84.678-78.246h16.008v19.32h26.772v14.214h-26.772v34.914c0 6.072 3.312 9.798 9.384 9.798h17.112v14.2135h-19.182c-16.146 0-23.322-8.2795-23.322-22.3555v-36.57h-19.734v-14.214h19.734zm80.814 19.32 1.104 13.662c2.484-9.384 8.418-13.662 18.078-13.662h15.318v14.214h-14.076c-10.626 0-15.042 5.106-15.042 16.422v28.29h22.494v14.2135h-56.994v-14.2135h18.492v-44.712h-18.492v-14.214zm38.31 22.08c2.898-14.766 15.042-23.736 31.05-23.736 18.078 0 29.532 10.488 29.532 30.636v24.978c0 3.588 1.38 4.968 4.416 4.968h3.312v14.2135h-4.002c-8.832 0-14.076-4.692-15.456-11.1775-2.898 7.0375-11.868 12.8335-23.184 12.8335-14.904 0-26.91-7.866-26.91-20.8375 0-15.042 10.902-20.424 28.704-23.598l17.112-3.312c-.276-9.522-5.658-14.352-13.938-14.352-7.314 0-12.558 4.278-13.938 10.35zm15.732 31.05c.138 4.416 4.002 7.866 12.144 7.866 9.66 0 16.836-6.762 16.836-17.94v-2.622l-13.386 2.346c-9.246 1.518-15.732 2.76-15.594 10.35zm102.48-25.944c-1.242-8.832-7.866-14.49-15.732-14.49-11.178 0-17.664 8.97-17.664 23.874 0 14.766 6.486 23.874 17.664 23.874 8.28 0 14.904-5.796 16.146-15.18l16.974.828c-2.07 17.388-16.008 28.7035-33.12 28.7035-20.976 0-34.5-14.9035-34.5-38.2255s13.524-38.226 34.5-38.226c16.56 0 30.774 11.04 32.706 27.876zm64.392-27.186v58.926h21.252v14.2135h-62.514v-14.2135h25.254v-44.712h-25.254v-14.214zm-16.836-9.522v-15.31801h16.698v15.31801zm59.838-9.798h16.008v19.32h26.772v14.214h-26.772v34.914c0 6.072 3.312 9.798 9.384 9.798h17.112v14.2135h-19.182c-16.146 0-23.322-8.2795-23.322-22.3555v-36.57h-19.734v-14.214h19.734zm48.384 55.89c0-23.322 13.524-38.226 34.638-38.226 16.974 0 32.568 11.04 33.396 37.536v4.83h-50.922c1.104 12.42 7.314 19.734 17.526 19.734 6.624 0 12.558-4.002 15.318-10.764l16.974 1.656c-4.14 14.214-16.974 23.4595-32.292 23.4595-21.114 0-34.638-14.9035-34.638-38.2255zm17.526-7.314h33.12c-1.932-11.73-8.556-16.56-16.008-16.56-9.246 0-15.318 6.21-17.112 16.56z"/></g></svg>

package/package.json

@@ -0,0 +1,78 @@
+{
+  "dependencies": {
+    "@next/eslint-plugin-next": "^14.0.4",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-cypress": "^2.15.1",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-n": "^16.4.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-storybook": "^0.6.15",
+    "eslint-plugin-tailwindcss": "^3.13.0",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "globals": "^13.24.0",
+    "prettier-plugin-tailwindcss": "^0.5.9",
+    "stylelint-config-idiomatic-order": "^10.0.0",
+    "stylelint-config-standard": "^35.0.0",
+    "stylelint-prettier": "^5.0.0"
+  },
+  "peerDependencies": {
+    "eslint": "^8.55.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.1",
+    "stylelint": "^16.0.2",
+    "typescript": "^5.3.3"
+  },
+  "devDependencies": {
+    "eslint": "^8.55.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.1",
+    "stylelint": "^16.0.2",
+    "typescript": "^5.3.3"
+  },
+  "name": "ultracite",
+  "description": "Strict, opinionated ESLint config for modern TypeScript apps.",
+  "version": "3.2.1",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/haydenbleasel/ultracite.git"
+  },
+  "main": "./eslint.config.mjs",
+  "keywords": [
+    "ultracite",
+    "eslint",
+    "prettier",
+    "stylelint",
+    "typescript"
+  ],
+  "author": "Hayden Bleasel <hello@haydenbleasel.com>",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/haydenbleasel/ultracite/issues"
+  },
+  "homepage": "https://github.com/haydenbleasel/ultracite#readme",
+  "prettier": "./prettier.js",
+  "stylelint": {
+    "extends": "./stylelint.js"
+  },
+  "auto": {
+    "plugins": [
+      "npm",
+      "all-contributors",
+      "conventional-commits",
+      "first-time-contributor",
+      "released"
+    ]
+  }
+}

package/prettier.js

@@ -0,0 +1,13 @@
+/* eslint-disable import/no-commonjs, import/unambiguous */
+
+module.exports = {
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'es5',
+  bracketSpacing: true,
+  arrowParens: 'always',
+  proseWrap: 'never',
+  printWidth: 80,
+};

package/rules/cypress.mjs

@@ -0,0 +1,17 @@
+import plugin from 'eslint-plugin-cypress';
+
+const { rules } = plugin;
+
+const availableKeys = Object.keys(rules).filter(
+  (key) => !rules[key].meta.deprecated
+);
+
+const baseRules = Object.fromEntries(
+  availableKeys.map((key) => [`cypress/${key}`, 'error'])
+);
+
+const overrideRules = {};
+
+const config = Object.assign(baseRules, overrideRules);
+
+export default config;

package/rules/eslint-typescript.mjs

@@ -0,0 +1,43 @@
+const config = {
+  // ESLint Disabled for Typescript-ESLint
+  'brace-style': 'off',
+  camelcase: 'off',
+  'comma-dangle': 'off',
+  'comma-spacing': 'off',
+  'default-param-last': 'off',
+  'dot-notation': 'off',
+  'func-call-spacing': 'off',
+  indent: 'off',
+  'init-declarations': 'off',
+  'keyword-spacing': 'off',
+  'lines-between-class-members': 'off',
+  'no-array-constructor': 'off',
+  'no-dupe-class-members': 'off',
+  'no-duplicate-imports': 'off',
+  'no-empty-function': 'off',
+  'no-extra-parens': 'off',
+  'no-extra-semi': 'off',
+  'no-implied-eval': 'off',
+  'no-invalid-this': 'off',
+  'no-loop-func': 'off',
+  'no-loss-of-precision': 'off',
+  'no-magic-numbers': 'off',
+  'no-redeclare': 'off',
+  'no-restricted-imports': 'off',
+  'no-shadow': 'off',
+  'no-throw-literal': 'off',
+  'no-unused-expressions': 'off',
+  'no-unused-vars': 'off',
+  'no-use-before-define': 'off',
+  'no-useless-constructor': 'off',
+  'object-curly-spacing': 'off',
+  'padding-line-between-statements': 'off',
+  quotes: 'off',
+  'require-await': 'off',
+  'no-return-await': 'off',
+  semi: 'off',
+  'space-before-function-paren': 'off',
+  'space-infix-ops': 'off',
+};
+
+export default config;