From cba57377e4c86d20d17042d6999eabc754fddc03 Mon Sep 17 00:00:00 2001 From: zanminkian Date: Fri, 7 Mar 2025 11:00:44 +0800 Subject: [PATCH] feat: add declaration file (#280) Co-authored-by: JounQin --- .changeset/moody-teachers-build.md | 5 +++++ .eslintrc.base.js | 6 ++++++ .github/workflows/release.yml | 1 + eslint.config.js | 6 ++++++ index.d.ts | 7 +++++++ package-lock.json | 4 ++-- package.json | 4 +++- scripts/build.js | 1 + 8 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 .changeset/moody-teachers-build.md create mode 100644 index.d.ts diff --git a/.changeset/moody-teachers-build.md b/.changeset/moody-teachers-build.md new file mode 100644 index 0000000..b8f8259 --- /dev/null +++ b/.changeset/moody-teachers-build.md @@ -0,0 +1,5 @@ +--- +"eslint-config-prettier": patch +--- + +feat: add declaration file diff --git a/.eslintrc.base.js b/.eslintrc.base.js index d4117d2..0b80fb9 100644 --- a/.eslintrc.base.js +++ b/.eslintrc.base.js @@ -114,6 +114,12 @@ module.exports = { files: ["test-lint/@stylistic__ts.ts"], extends: ["plugin:@stylistic/ts/all-extends"], }, + { + files: ["**/*.d.ts"], + rules: { + strict: "off", + }, + }, ], settings: { react: { diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f7edf8a..d514d15 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,6 +32,7 @@ jobs: commit: "chore: release eslint-config-prettier" title: "chore: release eslint-config-prettier" publish: npm run release + version: npm run version env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/eslint.config.js b/eslint.config.js index 1f2b6d2..6ab6713 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -34,4 +34,10 @@ module.exports = [ }, }) ), + { + files: ["**/*.d.ts"], + rules: { + strict: "off", + }, + }, ]; diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..5f70a5d --- /dev/null +++ b/index.d.ts @@ -0,0 +1,7 @@ +type Config = { + rules: Record; +}; + +declare const config: Config; + +export = config; diff --git a/package-lock.json b/package-lock.json index bd85dd9..1e9aa67 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "eslint-config-prettier", - "version": "10.0.1", + "version": "10.0.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "eslint-config-prettier", - "version": "10.0.1", + "version": "10.0.2", "license": "MIT", "bin": { "eslint-config-prettier": "build/bin/cli.js" diff --git a/package.json b/package.json index 7c0ee82..0c436c3 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "repository": "prettier/eslint-config-prettier", "bin": "build/bin/cli.js", "main": "build/index.js", + "types": "build/index.d.ts", "type": "commonjs", "files": [ "build" @@ -36,7 +37,8 @@ "test:with-env": "npm run test:eslint && npm run test:jest && npm run test:cli-sanity && npm run test:cli-sanity-warning", "test": "npm run test:prettier && ESLINT_CONFIG_PRETTIER_NO_DEPRECATED=true npm run test:with-env && ESLINT_USE_FLAT_CONFIG=false npm run test:with-env && npm run build", "build": "node scripts/build.js", - "release": "npm run build && clean-pkg-json && changeset publish" + "release": "npm run build && clean-pkg-json && changeset publish", + "version": "changeset version && npm i" }, "devDependencies": { "@babel/eslint-parser": "7.23.3", diff --git a/scripts/build.js b/scripts/build.js index f2ce427..bfeab0d 100644 --- a/scripts/build.js +++ b/scripts/build.js @@ -8,6 +8,7 @@ const BUILD = path.join(DIR, "build"); const FILES_TO_COPY = [ { src: "index.js" }, + { src: "index.d.ts" }, { src: "prettier.js" }, ...fs .readdirSync(path.join(DIR, "bin"))