Skip to content

chore: Introduce Knip #18005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Mar 11, 2024
Merged

chore: Introduce Knip #18005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
7831590
chore: add Knip + config
webpro Jan 18, 2024
8a222a9
chore: use named exports consistently (only shorthands)
webpro Jan 18, 2024
76dd0e8
chore: update Knip & reduce config (by improved 11ty plugin)
webpro Jan 19, 2024
9750f81
chore: rename `lint:knip` → `lint:imports`
webpro Jan 23, 2024
0889b43
chore: upgrade Knip to v4.3.0
webpro Feb 1, 2024
1d890c2
chore: fix createCoreRuleConfigs import in test
webpro Feb 5, 2024
f7d6b38
chore: annotate default export for runtime-info (to satisfy both prox…
webpro Feb 7, 2024
4c7bc82
chore: update knip.jsonc
webpro Feb 9, 2024
bb6de2b
chore: add comment to export/import hint
webpro Feb 14, 2024
5baac95
chore: upgrade Knip to v5.0.1 (no breaking changes)
webpro Feb 14, 2024
055091c
chore: remove unused files, dependencies & exports
webpro Feb 27, 2024
e0781b0
chore: fix whitespace in ci.yml
webpro Feb 27, 2024
e655f22
chore: add Knip to CI job
webpro Feb 27, 2024
23c4416
Remove tools/update-rule-types.js from knip.jsonc
JoshuaKGoldberg Mar 11, 2024
d6f4138
Add corrected shared/types Rule import to lazy-loading-rule-map.js
JoshuaKGoldberg Mar 11, 2024
f04054a
Added back eslint-plugin-* devDependencies
JoshuaKGoldberg Mar 11, 2024
b5881ee
Rename to lint:unused
JoshuaKGoldberg Mar 11, 2024
9aa8c63
Merge branch 'main' into introduce-knip
JoshuaKGoldberg Mar 11, 2024
83de5e5
Fix introduced prism-eslint-hook complaints
JoshuaKGoldberg Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 51 additions & 49 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,34 @@ jobs:
name: Verify Files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 'lts/*'
- name: Install Packages
run: npm install --force
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "lts/*"
- name: Install Packages
run: npm install --force

- name: Install Docs Packages
working-directory: docs
run: npm install
- name: Install Docs Packages
working-directory: docs
run: npm install

- name: Lint Files
run: node Makefile lint
- name: Lint Files
run: node Makefile lint

- name: Check Rule Files
run: node Makefile checkRuleFiles
- name: Check Rule Files
run: node Makefile checkRuleFiles

- name: Check Licenses
run: node Makefile checkLicenses
- name: Check Licenses
run: node Makefile checkLicenses

- name: Lint Docs JS Files
run: node Makefile lintDocsJS
- name: Lint Docs JS Files
run: node Makefile lintDocsJS

- name: Check Rule Examples
run: node Makefile checkRuleExamples
- name: Check Rule Examples
run: node Makefile checkRuleExamples

- name: Lint Files, Dependencies, & Exports
run: npm run lint:unused

test_on_node:
name: Test
Expand All @@ -47,40 +49,40 @@ jobs:
os: [ubuntu-latest]
node: [21.x, 20.x, 18.x, "18.18.0"]
include:
- os: windows-latest
node: "lts/*"
- os: macOS-latest
node: "lts/*"
- os: windows-latest
node: "lts/*"
- os: macOS-latest
node: "lts/*"
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
- name: Install Packages
run: npm install --force
- name: Test
run: node Makefile mocha
- name: Fuzz Test
run: node Makefile fuzz
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
- name: Install Packages
run: npm install --force
- name: Test
run: node Makefile mocha
- name: Fuzz Test
run: node Makefile fuzz

test_on_browser:
name: Browser Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20' # Should be the same as the version used on Netlify to build the ESLint Playground
- name: Install Packages
run: npm install --force
- name: Test
run: node Makefile wdio
- name: Fuzz Test
run: node Makefile fuzz
- uses: actions/upload-artifact@v3
if: failure()
with:
name: logs
path: |
wdio-logs/*.log
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: "20" # Should be the same as the version used on Netlify to build the ESLint Playground
- name: Install Packages
run: npm install --force
- name: Test
run: node Makefile wdio
- name: Fuzz Test
run: node Makefile fuzz
- uses: actions/upload-artifact@v3
if: failure()
with:
name: logs
path: |
wdio-logs/*.log
4 changes: 2 additions & 2 deletions Makefile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,8 +532,8 @@ target.lintDocsJS = function([fix = false] = []) {
};

target.fuzz = function({ amount = 1000, fuzzBrokenAutofixes = false } = {}) {
const fuzzerRunner = require("./tools/fuzzer-runner");
const fuzzResults = fuzzerRunner.run({ amount, fuzzBrokenAutofixes });
const { run } = require("./tools/fuzzer-runner");
const fuzzResults = run({ amount, fuzzBrokenAutofixes });

if (fuzzResults.length) {

Expand Down
3 changes: 2 additions & 1 deletion bin/eslint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,8 @@ ${getErrorMessage(error)}`;
}

// Otherwise, call the CLI.
const exitCode = await require("../lib/cli").execute(
const cli = require("../lib/cli");
const exitCode = await cli.execute(
process.argv,
process.argv.includes("--stdin") ? await readStdin() : null,
true
Expand Down
4 changes: 2 additions & 2 deletions docs/.eleventy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const {
} = require("luxon");
const markdownIt = require("markdown-it");
const markdownItRuleExample = require("./tools/markdown-it-rule-example");
const { addContentMustBeMarked } = require("./tools/prism-eslint-hook");
const prismESLintHook = require("./tools/prism-eslint-hook");

module.exports = function(eleventyConfig) {

Expand Down Expand Up @@ -197,7 +197,7 @@ module.exports = function(eleventyConfig) {
const ruleExampleOptions = markdownItRuleExample({
open({ type, code, parserOptions, env, codeBlockToken }) {

addContentMustBeMarked(codeBlockToken.content, parserOptions);
prismESLintHook.addContentMustBeMarked(codeBlockToken.content, parserOptions);

const isRuleRemoved = !Object.hasOwn(env.rules_meta, env.title);

Expand Down
5 changes: 0 additions & 5 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,15 @@
"autoprefixer": "^10.4.13",
"cross-env": "^7.0.3",
"cssnano": "^5.1.14",
"dom-parser": "^0.1.6",
"eleventy-plugin-nesting-toc": "^1.3.0",
"eleventy-plugin-page-assets": "^0.3.0",
"eleventy-plugin-reading-time": "^0.0.1",
"github-slugger": "^1.5.0",
"hyperlink": "^5.0.4",
"imagemin": "^8.0.1",
"imagemin-cli": "^7.0.0",
"js-yaml": "^3.14.1",
"luxon": "^2.4.0",
"markdown-it": "^12.2.0",
"markdown-it-anchor": "^8.1.2",
"markdown-it-container": "^3.0.0",
"netlify-cli": "^10.3.1",
"npm-run-all2": "^5.0.0",
"postcss-cli": "^10.0.0",
"postcss-html": "^1.5.0",
Expand Down
4 changes: 3 additions & 1 deletion docs/src/_plugins/md-syntax-highlighter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ SOFTWARE.

const Prism = require("prismjs");
const loadLanguages = require("prismjs/components/");
require("../../tools/prism-eslint-hook").installPrismESLintMarkerHook();
const prismESLintHook = require("../../tools/prism-eslint-hook");

prismESLintHook.installPrismESLintMarkerHook();

/**
*
Expand Down
52 changes: 52 additions & 0 deletions knip.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful if you could explain what all of this does.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the configuration comes down to providing entry files in order for Knip to do its thing.

This repository is much like a monorepo, but without explicitly defined workspaces as package managers like npm and pnpm recognize them. Knip normally hooks into package.json#workspaces, but those folders with a package.json manifest can also be manually added to the Knip configuration file. So the keys of the workspaces object are the paths to those folders.

"workspaces": {
".": {
// These entries are complementary to the ones found in package.json
"entry": [
"lib/rules/index.js",
"tools/internal-rules/index.js",
// https://github.com/webpro/knip/issues/464
// Remove when Knip has a wdio plugin
"wdio.conf.js"
],
"project": ["{conf,lib,tools}/**/*.js"],
"mocha": {
"entry": [
"tests/{bin,conf,lib,tools}/**/*.js", // see Makefile.js
"tests/_utils/test-lazy-loading-rules.js"
],
"project": ["tests/**/*.js"]
},
"ignore": [
// If Knip would consider exports as named, their usage is too dynamic: globals[`es${ecmaVersion}`]
// An alternative is to add `__esModule: true` to the export and we can remove it here from the ignores:
"conf/globals.js",
// These contain unresolved imports and other oddities:
"tests/bench/large.js",
"tests/lib/rule-tester/rule-tester.js",
"tests/performance/jshint.js",
// Many are required using dynamic paths such as `fs.readFileSync(path.join())`:
"tests/fixtures/**"
],
"ignoreDependencies": [
"c8",

// These will be removed in https://github.com/eslint/eslint/pull/18011
"eslint-plugin-eslint-comments",
"eslint-plugin-jsdoc",
"eslint-plugin-n",
"eslint-plugin-unicorn",

// Ignore until Knip has a wdio plugin:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Ignore until Knip has a wdio plugin:
// Ignore until Knip has a wdio plugin:
// https://github.com/webpro/knip/issues/483#issuecomment-1925751516

"@wdio/*",
"rollup-plugin-node-polyfills"
]
},
"docs": {
"ignore": ["src/assets/js/search.js", "_examples/**"]
},
// Workspaces with default configs:
"packages/*": {},
"tools/internal-rules": {}
}
}
34 changes: 0 additions & 34 deletions lib/cli-engine/xml-escape.js
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions lib/config/flat-config-schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,5 @@ const flatConfigSchema = {

module.exports = {
flatConfigSchema,
assertIsRuleSeverity,
assertIsRuleOptions
assertIsRuleSeverity
};
1 change: 0 additions & 1 deletion lib/eslint/eslint-helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,6 @@ function getCacheFile(cacheFile, cwd) {
//-----------------------------------------------------------------------------

module.exports = {
isGlobPattern,
findFiles,

isNonEmptyString,
Expand Down
4 changes: 1 addition & 3 deletions lib/linter/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
"use strict";

const { Linter } = require("./linter");
const { interpolate } = require("./interpolate");
const SourceCodeFixer = require("./source-code-fixer");

module.exports = {
Linter,

// For testers.
SourceCodeFixer,
interpolate
SourceCodeFixer
};
2 changes: 0 additions & 2 deletions lib/linter/linter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ const { LATEST_ECMA_VERSION } = require("../../conf/ecma-version");
// Typedefs
//------------------------------------------------------------------------------

/** @typedef {InstanceType<import("../cli-engine/config-array").ConfigArray>} ConfigArray */
/** @typedef {InstanceType<import("../cli-engine/config-array").ExtractedConfig>} ExtractedConfig */
/** @typedef {import("../shared/types").ConfigData} ConfigData */
/** @typedef {import("../shared/types").Environment} Environment */
/** @typedef {import("../shared/types").GlobalConf} GlobalConf */
Expand Down
4 changes: 3 additions & 1 deletion lib/rule-tester/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
"use strict";

const RuleTester = require("./rule-tester");

module.exports = {
RuleTester: require("./rule-tester")
RuleTester
};
2 changes: 1 addition & 1 deletion lib/rules/utils/lazy-loading-rule-map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

const debug = require("debug")("eslint:rules");

/** @typedef {import("./types").Rule} Rule */
/** @typedef {import("../../shared/types").Rule} Rule */

/**
* The `Map` object that loads each rule when it's accessed.
Expand Down
13 changes: 9 additions & 4 deletions lib/rules/utils/unicode/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@
*/
"use strict";

const isCombiningCharacter = require("./is-combining-character");
const isEmojiModifier = require("./is-emoji-modifier");
const isRegionalIndicatorSymbol = require("./is-regional-indicator-symbol");
const isSurrogatePair = require("./is-surrogate-pair");

module.exports = {
isCombiningCharacter: require("./is-combining-character"),
isEmojiModifier: require("./is-emoji-modifier"),
isRegionalIndicatorSymbol: require("./is-regional-indicator-symbol"),
isSurrogatePair: require("./is-surrogate-pair")
isCombiningCharacter,
isEmojiModifier,
isRegionalIndicatorSymbol,
isSurrogatePair
};
Loading