工程基础配置

nuxt.conig.ts

export default defineNuxtConfig({
  //...
  modules: ['@nuxt/eslint'],
  eslint: {
    config: {
      stylistic: true,
      formatters: {
        css: 'prettier',
        html: 'prettier',
      },
    },
  },
  //...
})

import tsEslintParaser from '@typescript-eslint/parser'
// 自定义eslint 规则做规范～ e.g: 禁止localStorage泛用，而应该模块化集中管理
const plugin = {
  meta: {
    name: 'eslint-plugin-booking',
  },
  configs: {},
  rules: {
    'no-localstorage': {
      meta: {
        schema: [
          {
            type: 'object',
            properties: {
              msg: { type: 'string' },
            },
            additionalProperties: false,
          },
        ],
      },

      create(context) {
        const option = context.options[0]

        return {
          MemberExpression(node) {
            let objectName
            if (node.object.type === 'Identifier') {
              objectName = node.object.name
            }
            else if (
              node.object.type === 'TSAsExpression'
              && node.object.expression.type === 'Identifier'
            ) {
              objectName = node.object.expression.name
            }
            else if (
              node.object.type === 'MemberExpression'
              && node.object.object.type === 'Identifier'
              && node.object.object.name === 'window'
              && node.object.property.type === 'Identifier'
              && node.object.property.name === 'localStorage'
            ) {
              objectName = 'window.localStorage'
            }

            if (objectName === 'localStorage' || objectName === 'window.localStorage') {
              context.report({
                node,
                message: `(订舱eslint): ${option.msg}.`,
              })
            }
          },

        }
      },

    },
  },
}

/**
 * @param {object} options - 配置项
 * @param {string} options.msg - report 消息
 * @param {Array<string>} options.ignores - 忽略模块
 * @returns {Array<object>} ESLint Flat Config 配置数组
 */
const createLocalEslintRule = (options) => {
  const { msg = '', ignores = [] } = options
  return [
    {
      files: ['**/*.{js,ts,jsx,tsx}'],
      languageOptions: {
        parser: tsEslintParaser,
      },
      plugins: {
        '@booking-eslint': plugin,
      },
      rules: {
        '@booking-eslint/no-localstorage': ['error', { msg }],
      },
    },
    {
      files: ignores,
      rules: {
        '@booking-eslint/no-localstorage': 'off',
      },
    },
  ]
}
export default {
  createLocalEslintRule,
}

import { defineConfig } from 'cz-git'

export default defineConfig({
  rules: {
    // @see: https://commitlint.js.org/#/reference-rules
  },
  prompt: {
    alias: { fd: 'docs: fix typos' },
    messages: {
      type: 'Select the type of change that you\'re committing:',
      scope: 'Denote the SCOPE of this change (optional):',
      customScope: 'Denote the SCOPE of this change:',
      subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
      body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
      breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
      footerPrefixSelect: 'Select the ISSUES type of changeList by this change (optional):',
      customFooterPrefix: 'Input ISSUES prefix:',
      footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
      generatingByAI: 'Generating your AI commit subject...',
      generatedSelectByAI: 'Select suitable subject by AI generated:',
      confirmCommit: 'Are you sure you want to proceed with the commit above?',
    },
    types: [
      { value: 'feat', name: 'feat:     A new feature', emoji: ':sparkles:' },
      { value: 'fix', name: 'fix:      A bug fix', emoji: ':bug:' },
      { value: 'docs', name: 'docs:     Documentation only changes', emoji: ':memo:' },
      { value: 'style', name: 'style:    Changes that do not affect the meaning of the code', emoji: ':lipstick:' },
      { value: 'refactor', name: 'refactor: A code change that neither fixes a bug nor adds a feature', emoji: ':recycle:' },
      { value: 'perf', name: 'perf:     A code change that improves performance', emoji: ':zap:' },
      { value: 'test', name: 'test:     Adding missing tests or correcting existing tests', emoji: ':white_check_mark:' },
      { value: 'build', name: 'build:    Changes that affect the build system or external dependencies', emoji: ':package:' },
      { value: 'ci', name: 'ci:       Changes to our CI configuration files and scripts', emoji: ':ferris_wheel:' },
      { value: 'chore', name: 'chore:    Other changes that don\'t modify src or test files', emoji: ':hammer:' },
      { value: 'revert', name: 'revert:   Reverts a previous commit', emoji: ':rewind:' },
    ],
    useEmoji: true,
    emojiAlign: 'center',
    useAI: false,
    aiNumber: 1,
    themeColorCode: '',
    scopes: [],
    allowCustomScopes: true,
    allowEmptyScopes: true,
    customScopesAlign: 'bottom',
    customScopesAlias: 'custom',
    emptyScopesAlias: 'empty',
    upperCaseSubject: false,
    markBreakingChangeMode: false,
    allowBreakingChanges: ['feat', 'fix'],
    breaklineNumber: 100,
    breaklineChar: '|',
    skipQuestions: [],
    issuePrefixes: [{ value: 'closed', name: 'closed:   ISSUES has been processed' }],
    customIssuePrefixAlign: 'top',
    emptyIssuePrefixAlias: 'skip',
    customIssuePrefixAlias: 'custom',
    allowCustomIssuePrefix: true,
    allowEmptyIssuePrefix: true,
    confirmColorize: true,
    scopeOverrides: undefined,
    defaultBody: '',
    defaultIssues: '',
    defaultScope: '',
    defaultSubject: '',
  },
})