Introduction

npm i -D @meojs/cfgs

TSConfig

{
  "extends": "@meojs/cfgs/ts/general.json",
  "include": ["src"],
}

• @meojs/cfgs/ts/base.json - Configuration with rules only.
• @meojs/cfgs/ts/general.json - Common configuration for ES modules.
• @meojs/cfgs/ts/cocos.json - Configuration for Cocos Creator projects.
• @meojs/cfgs/ts/node.json - Configuration for NodeJS projects.

ESLint Config

import { eslint } from "@xenon.js/configs";

export default eslint.config({
  // Whether to add `.gitignore` ignore, by default uses `cwd()` to find the `.gitignore` file path.
  gitignore?: boolean | string,
  // Ignore all `*.config` configuration files, such as `eslint.config.js`, default is `true`.
  ignoreConfigFiles?: boolean,
  // JSDoc inspection level, default is `loose`.
  jsdoc?: "none" | "loose" | "strict",
  // Include NodeJS related rules, default is `strict`.
  nodejs?: "none" | "loose" | "strict",
  // Include Web related rules, default is `true`.
  web?: boolean,
  // Additional allowed JSDoc tags.
  jsdocTags?: string[],
  // Whether to be compatible with reactive libraries, default is `true`.
  reactive?: boolean,
});

Prettier Config

import { prettier } from '@xenon.js/configs';

export default prettier.config({
  // Whether to use Tailwind CSS, default `false`.
  tailwindcss?: boolean;
});

Editor Config

Please manually copy the files from the editorconfig directory.

Repo Template

Please manually copy the files from the repo directory.

Contributing

Points to Consider

• After updating .editorconfig, the references in @meojs/utc need to be synchronized updated.

Build & Publish

• Run pnpm run build to build the project.
• Run pnpm run publish:version to build and push a new version.

License

MIT @ SmallMain