@polariens/kitsune-lint

kitsune-lint 🦊

Português | English

Configurações opinativas de ESLint, Prettier e Stylelint para projetos de alta qualidade em Vue 3, TypeScript e Vitest. Código limpo com regras afiadas.

Ajuda desenvolvedores a iniciar projetos JavaScript/TypeScript sem a complexidade de configurar regra por regra, entregando padrões rigorosos de linting, segurança e qualidade já travados para garantir código limpo e seguro — especialmente em bases aceleradas por Inteligência Artificial.

Mantido oficialmente pela Polariens, uma instituição sem fins lucrativos focada em tecnologia aberta e impacto comunitário.

Kitsune (狐) é a raposa mística do folclore japonês — astuta, adaptável e capaz de se transformar conforme o contexto. Assim como a kitsune, este pacote se molda ao seu projeto: você escolhe os módulos e as opções, e ele compõe as regras certas para cada cenário. Código limpo com a precisão de uma raposa.

Sumário

• kitsune-lint 🦊
  • Sumário
  • O que é
  • Instalação
    • 1. Dependências Básicas (Obrigatório)
    • 2. Instalação Completa (Todos os módulos)
    • 3. Instalação Modular (Por Demanda)
  • ESLint
    • Factory Function (Recomendado)
    • Customizando Módulos
    • Imports Granulares
    • Estendendo Configurações Externas
  • Prettier
    • Instalação
    • Uso Padrão
    • Com Overrides
  • Stylelint
    • Instalação
    • Uso Padrão
    • Com Overrides
  • CLI e Utilitários
  • Referência dos Módulos
    • Visão Geral
    • Opções Detalhadas
      • base
      • typescript
      • security
      • cleanCode
      • vue
      • pinia
      • tests
      • vitest
  • Estrutura do Pacote
  • Licença e Governança

O que é

O kitsune-lint padroniza regras de linting, formatação e qualidade de código através do formato moderno Flat Config do ESLint (v9+), além de integrar Prettier e Stylelint (SCSS & Vue SFC).

• Modular: Ative apenas o que seu projeto utiliza (vue, pinia, vitest, etc.).
• TypeScript First: Tipagem nativa completa para todas as opções (.d.mts).
• Regras Customizadas: Regras AST exclusivas (kitsune/alias-imports e kitsune/no-null-in-types).
• Zero Lock-in: Compatível com extensões e plugins de terceiros via extend.

Instalação

Instale o pacote principal como dependência de desenvolvimento:

npm install --save-dev kitsune-lint

Nota: Se o seu projeto estiver consumindo via escopo da organização:

npm install --save-dev @polariens/kitsune-lint

As peer dependencies devem ser instaladas no projeto consumidor de acordo com os módulos desejados.

1. Dependências Básicas (Obrigatório)

Essenciais para os módulos base que vêm ativos por padrão (base, typescript, cleanCode):

npm install --save-dev eslint @eslint/js typescript-eslint globals

2. Instalação Completa (Todos os módulos)

Para projetos que utilizam a suíte completa (TypeScript + Vue 3 + Pinia + Vitest + Security):

npm install --save-dev eslint @eslint/js typescript-eslint globals eslint-plugin-security eslint-plugin-vue vue-eslint-parser eslint-plugin-pinia @vitest/eslint-plugin

3. Instalação Modular (Por Demanda)

Instale apenas os plugins necessários para os módulos que for ativar:

• Módulo security (ativo por padrão):

  npm install --save-dev eslint-plugin-security
  

• Módulo vue:

  npm install --save-dev eslint-plugin-vue vue-eslint-parser
  

• Módulo pinia:

  npm install --save-dev eslint-plugin-pinia
  

• Módulo vitest:

  npm install --save-dev @vitest/eslint-plugin
  

ESLint

Factory Function (Recomendado)

O método createKitsuneConfig é assíncrono e unifica as regras ativando/desativando módulos de forma declarativa:

// eslint.config.js ou eslint.config.mjs
import { createKitsuneConfig } from 'kitsune-lint/eslint';

export default await createKitsuneConfig({
  vue: true,
  pinia: true,
  tests: true,
  vitest: true,
});

Por padrão, base, typescript, security e cleanCode vêm ativados (true). Para desligar algum, basta passar false:

export default await createKitsuneConfig({
  security: false,
  vue: true,
});

Customizando Módulos

Em vez de true, passe um objeto com opções específicas:

// eslint.config.js
import { createKitsuneConfig } from 'kitsune-lint/eslint';

export default await createKitsuneConfig({
  base: {
    environment: 'node', // 'browser' | 'node' | 'shared-node-browser'
  },
  cleanCode: {
    maxDepth: 3,
    maxParams: 3,
    complexity: 10,
    maxLines: 300,
    maxLinesPerFunction: 60,
  },
  vue: {
    apiStyle: 'script-setup', // 'script-setup' | 'composition' | 'options'
    componentsNameCasing: 'PascalCase',
    propNameCasing: 'camelCase',
    maxTemplateDepth: 5,
  },
  pinia: {
    files: ['src/stores/**/*.ts'],
  },
  vitest: {
    fn: 'test', // 'test' | 'it'
    maxNestedDescribe: 2,
  },
});

Imports Granulares

Para controle manual completo da composição da configuração:

// eslint.config.js
import { base } from 'kitsune-lint/eslint/base';
import { typescript } from 'kitsune-lint/eslint/typescript';
import { cleanCode } from 'kitsune-lint/eslint/clean-code';
import { security } from 'kitsune-lint/eslint/security';
import { vue } from 'kitsune-lint/eslint/vue';
import { pinia } from 'kitsune-lint/eslint/pinia';

export default [
  ...base({ environment: 'browser' }),
  ...typescript(),
  ...cleanCode(),
  ...security(),
  ...vue(),
  ...(await pinia()),
];

Estendendo Configurações Externas

Adicione regras e plugins externos diretamente pela chave extend:

// eslint.config.js
import { createKitsuneConfig } from 'kitsune-lint/eslint';
import eslintConfigPrettier from 'eslint-config-prettier';

export default await createKitsuneConfig({
  vue: true,
  extend: [
    eslintConfigPrettier,
  ],
});

Prettier

Configuração com regras estritas para consistência visual.

Instalação

npm install --save-dev prettier

Uso Padrão

// prettier.config.mjs ou .prettierrc.mjs
import prettierConfig from 'kitsune-lint/prettier';

export default prettierConfig;

Com Overrides

Utilize a factory createPrettierKitsuneConfig:

// prettier.config.mjs
import { createPrettierKitsuneConfig } from 'kitsune-lint/prettier';

export default createPrettierKitsuneConfig({
  overrides: {
    printWidth: 120,
    singleQuote: true,
  },
  vue: true, // ativa indentação em <script> e <style>
});

Stylelint

Configuração focada em SCSS e SFCs do Vue, aplicando arquitetura de classes BEM por padrão.

Instalação

npm install --save-dev stylelint stylelint-config-standard-scss stylelint-config-recommended-vue postcss-html

Uso Padrão

// stylelint.config.mjs
import stylelintConfig from 'kitsune-lint/stylelint';

export default stylelintConfig;

Com Overrides

// stylelint.config.mjs
import { createStylelintKitsuneConfig } from 'kitsune-lint/stylelint';

export default createStylelintKitsuneConfig({
  classPattern: 'BEM', // 'BEM' | null
  rules: {
    'color-hex-length': 'short',
  },
});

CLI e Utilitários

O pacote inclui um utilitário CLI para sincronizar o .prettierignore recomendado em seu projeto:

npx kitsune-prettierignore

Para sobrescrever um arquivo existente:

npx kitsune-prettierignore --force

Referência dos Módulos

Visão Geral

Opções Detalhadas

base

typescript

security

cleanCode

vue

pinia

tests

vitest

Estrutura do Pacote

kitsune-lint/
├── bin/
│   └── copy-prettierignore.mjs   # CLI npx kitsune-prettierignore
├── eslint/
│   ├── index.mjs                 # Factory createKitsuneConfig + re-exports
│   ├── index.d.mts               # Tipos TypeScript das configurações
│   ├── plugin.mjs                # Plugin ESLint interno 'kitsune'
│   ├── utils.mjs                 # Utilitários compartilhados
│   ├── configs/                  # Módulos independentes de regras
│   │   ├── base.mjs
│   │   ├── clean-code.mjs
│   │   ├── pinia.mjs
│   │   ├── security.mjs
│   │   ├── tests.mjs
│   │   ├── typescript.mjs
│   │   ├── vitest.mjs
│   │   └── vue.mjs
│   └── rules/                    # Regras customizadas AST
│       ├── alias-imports.mjs
│       └── no-null-in-types.mjs
├── prettier/
│   ├── index.mjs                 # Configuração Prettier e factory
│   └── index.d.mts
├── stylelint/
│   ├── index.mjs                 # Configuração Stylelint e factory
│   └── index.d.mts
├── LICENSE
├── README.md                     # Documentação (Inglês)
├── README.pt-BR.md               # Documentação (Português)
└── package.json

Licença e Governança

Distribuído sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Desenvolvido e mantido pela Polariens — Instituição sem fins lucrativos comprometida com a sustentabilidade de ferramentas open-source para a comunidade.