1.1.1 • Published 8 months ago

@khaos.ca/config v1.1.1

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
8 months ago

@khaos.ca/config

npm License: MIT

Opinionated configurations.

Configurations

configDescription
commitlintConfigurations for commitlint
eslint/coreConfigurations for ESLint - Core
eslint/typescriptConfigurations for ESLint - TypeScript
eslint/browserConfigurations for ESLint - Browser
eslint/reactConfigurations for ESLint - React
eslint/react/typescriptConfigurations for ESLint - React (TypeScript)
eslint/next/typescriptConfigurations for ESLint - Next.js (TypeScript)
eslint/storybookConfigurations for ESLint - Storybook
eslint/node/scriptConfigurations for ESLint - Node.js (CommonJS)
eslint/node/moduleConfigurations for ESLint - Node.js (ESM)
eslint/node/module/typescriptConfigurations for ESLint - Node.js (ESM - TypeScript)
eslint/jestConfigurations for ESLint - Jest
eslint/jsonConfigurations for ESLint - JSON
prettierConfigurations for Prettier
stylelint/coreConfigurations for stylelint - Core
stylelint/sassConfigurations for stylelint - SASS
tsconfig/nextConfigurations for TypeScript - Next.js

Install

$ npm install @khaos.ca/config

Usage for commitlint

Add some commitlint config to your commitlint.config.js:

import config from "@khaos.ca/config/commitlint"

export default {
  ...config,
}

Usage for ESLint

Add some ESLint config to your eslint.config.js:

import nextConfig from "@khaos.ca/config/eslint/next/typescript"
import storybookConfig from "@khaos.ca/config/eslint/storybook"

export default [
  {
    name: "IGNORES",
    ignores: ["next-env.d.ts", ".next/*"],
  },

  ...nextConfig,
  ...storybookConfig,

  {
    name: "CONFIG",
    languageOptions: {
      parserOptions: {
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
]

Usage for Prettier

Add some Prettier config to your prettier.config.js:

import config from "@khaos.ca/config/prettier"

export default {
  ...config,
}

Usage for stylelint

Add some stylelint config to your stylelint.config.js:

import config from "@khaos.ca/config/stylelint/core"

export default {
  ...config,
}

Usage for TSConfig

Add some TSConfig config to your tsconfig.json:

{
  "extends": "@khaos.ca/config/tsconfig/next"
}

Documentation

See the Changelog to see what has changed.

Contribute

See the Contributing Guidelines for ways to get started.

See the Support Guide for ways to get help.

See the Security Policy for sharing vulnerability reports.

This project has a Code of Conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © khaos.ca