YuntiJS Lint

ESlint, Stylelint, Commitlint, Prettier, Remark, Semantic Release config for YuntiJS, based on Lobe Lint, eslint-config-tenx and stylelint-config-tenx.

Changelog · Report Bug · Request Feature

Table of contents

TOC

• 📦 Installation
• ☁️ Usage
  • .npmrc
  • ESlint
  • Prettier
  • Stylelint
  • Commitlint
  • Changelog
  • Semantic Release
  • Remark
• ⌨️ Local Development
• 🤝 Contributing

📦 Installation

To install YuntiJS Lint, run the following command:

pnpm add eslint@^8 prettier@^3 @yuntijs/lint -D

To use template ignore files, run the following command:

curl -O https://raw.githubusercontent.com/yuntijs/yunti-lint/main/.eslintignore
curl -O https://raw.githubusercontent.com/yuntijs/yunti-lint/main/.gitignore
curl -O https://raw.githubusercontent.com/yuntijs/yunti-lint/main/.prettierignore

☁️ Usage

.npmrc

please add the following to your .npmrc file first:

public-hoist-pattern[]=*@umijs/lint*
public-hoist-pattern[]=*changelog*
public-hoist-pattern[]=*commitlint*
public-hoist-pattern[]=*eslint*
public-hoist-pattern[]=*postcss*
public-hoist-pattern[]=*prettier*
public-hoist-pattern[]=*remark*
public-hoist-pattern[]=*semantic-release*
public-hoist-pattern[]=*stylelint*

ESlint

config can be found at .eslintrc.js

module.exports = require('@yuntijs/lint').eslint;
// ~ for Node.js project should use eslintNodejs
// module.exports = require('@yuntijs/lint').eslintNodejs;

Prettier

config can be found at .prettierrc.js

module.exports = require('@yuntijs/lint').prettier;

Stylelint

install stylelint first:

pnpm add stylelint@^15 -D

config can be found at .stylelintrc.js

module.exports = require('@yuntijs/lint').stylelint;

Commitlint

install commitlint first:

pnpm add commitlint@^18 -D

config can be found at .commitlintrc.js

module.exports = require('@yuntijs/lint').commitlint;

Changelog

config can be found at .changelogrc.js

module.exports = require('@yuntijs/lint').changelog;

Semantic Release

install semantic-release first:

pnpm add semantic-release@^21 -D

config can be found at .releaserc.js

module.exports = require('@yuntijs/lint').semanticRelease;
// ~ for monoRepo project should use semanticReleaseMonoRepo
// module.exports = require('@yuntijs/lint').semanticReleaseMonoRepo;

Remark

install remark first:

pnpm add remark@^14 remark-cli@^11 -D

config can be found at .remarkrc.js

module.exports = require('@yuntijs/lint').remarklint;

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

git clone https://github.com/yuntijs/yunti-lint.git
cd yuntijs/lint
pnpm install
pnpm start

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub Issues to get stuck in to show us what you’re made of.

---

📝 License

Copyright © 2023 YuntiJS.
This project is MIT licensed.