Skip to content
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.

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

Add plugin for moonrepo (moonrepo.dev) #579

Merged
merged 6 commits into from
Apr 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions packages/knip/.release-it.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"release": true,
"comments": {
"submit": true,
"issue": ":rocket: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes.\n\nUsing Knip in a commercial project? Please consider [sponsoring me](https://github.com/sponsors/webpro)._",
"pr": ":rocket: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes.\n\nUsing Knip in a commercial project? Please consider [sponsoring me](https://github.com/sponsors/webpro)._"
"issue": ":rocket: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._\n\n_Using Knip in a commercial project? Please consider [sponsoring me](https://github.com/sponsors/webpro)._",
"pr": ":rocket: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._\n\n_Using Knip in a commercial project? Please consider [sponsoring me](https://github.com/sponsors/webpro)._"
}
},
"plugins": {
Expand Down
3 changes: 3 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/.moon/tasks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
tasks:
lint.filenames:
command: 'ls-lint -workdir . -config $workspaceRoot/.ls-lint.yml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
tasks:
lint:
deps:
- lint.typecheck
- lint.code
lint.typecheck:
command: tsc --noEmit
lint.code:
command: eslint . --ignore-path $workspaceRoot/.gitignore --no-error-on-unmatched-pattern
3 changes: 3 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/apps/a/moon.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
tasks:
lint.readme:
command: 'vite-node $workspaceRoot/tools/linters/lint-readme.ts -- $projectRoot'
3 changes: 3 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/apps/a/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"name": "a"
}
3 changes: 3 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/libs/b/moon.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
tasks:
start.prod:
command: 'vitest ./server/server.ts'
6 changes: 6 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/libs/b/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "b",
"devDependencies": {
"vitest": "*"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const hi = 'hi';
8 changes: 8 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "@fixtures/moonrepo",
"devDependencies": {
"@moonrepo/cli": "*",
"vite-node": "*",
"eslint": "*"
}
}
3 changes: 3 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/pnpm-workspace.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
packages:
- 'apps/**'
- 'libs/**'
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const hi = 'hello';
3 changes: 3 additions & 0 deletions packages/knip/fixtures/plugins/moonrepo/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["@tsconfig/node20/tsconfig.json"]
}
4 changes: 4 additions & 0 deletions packages/knip/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,10 @@
"title": "Mocha plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/mocha/README.md)",
"$ref": "#/definitions/plugin"
},
"moonrepo": {
"title": "moonrepo plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/moonrepo/README.md)",
"$ref": "#/definitions/plugin"
},
"msw": {
"title": "Mocha plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/msw/README.md)",
"$ref": "#/definitions/plugin"
Expand Down
1 change: 1 addition & 0 deletions packages/knip/src/ConfigurationValidator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ export const pluginSchema = z.union([
]);

const pluginsSchema = z.object({
moonrepo: pluginSchema,
astro: pluginSchema,
angular: pluginSchema,
ava: pluginSchema,
Expand Down
1 change: 1 addition & 0 deletions packages/knip/src/WorkspaceWorker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ export class WorkspaceWorker {
const cwd = this.dir;

const baseOptions = {
rootCwd: this.cwd,
cwd,
manifest: this.manifest,
manifestScriptNames: this.manifestScriptNames,
Expand Down
1 change: 1 addition & 0 deletions packages/knip/src/binaries/resolvers/fallback.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const argFilters: ArgResolvers = {
esbuild: withPositional,
execa: withPositional,
vitest: withoutRequire,
'vite-node': withPositional,
zx: withPositional,
default: withoutPositional,
};
Expand Down
4 changes: 2 additions & 2 deletions packages/knip/src/binaries/util.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { getPackageNameFromFilePath, getPackageNameFromModuleSpecifier } from '../util/modules.js';
import { isInNodeModules, join } from '../util/path.js';
import { isAbsolute, isInNodeModules, join } from '../util/path.js';
import { toBinary } from '../util/protocols.js';
import { _tryResolve } from '../util/require.js';

export const tryResolveFilePath = (cwd: string, specifier: string, acceptModuleSpecifier?: boolean) => {
if (specifier) {
const filePath = join(cwd, specifier);
const filePath = isAbsolute(specifier) ? specifier : join(cwd, specifier);
if (!isInNodeModules(filePath)) {
const resolvedFilePath = _tryResolve(filePath, cwd);
if (resolvedFilePath) {
Expand Down
1 change: 1 addition & 0 deletions packages/knip/src/plugins/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,4 @@ export { default as webpack } from './webpack/index.js';
export { default as wireit } from './wireit/index.js';
export { default as wrangler } from './wrangler/index.js';
export { default as yorkie } from './yorkie/index.js';
export { default as moonrepo } from './moonrepo/index.js';
33 changes: 33 additions & 0 deletions packages/knip/src/plugins/moonrepo/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { getDependenciesFromScripts, hasDependency } from '#p/util/plugin.js';
import type { EnablerPatterns } from '#p/types/config.js';
import type { IsPluginEnabled, Plugin, ResolveConfig } from '#p/types/plugins.js';
import type { MoonConfiguration } from './types.js';

// link to moonrepo docs: https://moonrepo.dev/docs

const title = 'moonrepo';

const enablers: EnablerPatterns = ['@moonrepo/cli'];

const isEnabled: IsPluginEnabled = ({ dependencies }) => hasDependency(dependencies, enablers);

const config: string[] = ['moon.yml', '.moon/tasks.yml', '.moon/tasks/*.yml'];

const resolveConfig: ResolveConfig<MoonConfiguration> = async (config, options) => {
const tasks = config.tasks ? Object.values(config.tasks) : [];
const dependencies = tasks
.map(task => task.command)
.filter(command => command)
.map(command => command.replace('$workspaceRoot', options.rootCwd!))
.map(command => command.replace('$projectRoot', options.cwd))
.flatMap(command => getDependenciesFromScripts(command, options));
return [...dependencies];
};

export default {
title,
enablers,
isEnabled,
config,
resolveConfig,
} satisfies Plugin;
7 changes: 7 additions & 0 deletions packages/knip/src/plugins/moonrepo/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export interface MoonConfiguration {
tasks?: {
[taskName: string]: {
command: string;
};
};
}
1 change: 1 addition & 0 deletions packages/knip/src/types/plugins.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import type { PackageJson } from './package-json.js';
import type { DependencySet } from './workspace.js';

export interface BaseOptions {
rootCwd?: string;
cwd: string;
manifestScriptNames: Set<string>;
dependencies: DependencySet;
Expand Down
37 changes: 37 additions & 0 deletions packages/knip/test/plugins/moonrepo.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import assert from 'node:assert/strict';
import test from 'node:test';
import { main } from '../../src/index.js';
import { resolve, join } from '../../src/util/path.js';
import baseArguments from '../helpers/baseArguments.js';
import baseCounters from '../helpers/baseCounters.js';

const cwd = resolve('fixtures/plugins/moonrepo');

test('Find dependencies with the moonrepo plugin', async () => {
const { issues, counters } = await main({
...baseArguments,
cwd,
});

assert(issues.binaries['.moon/tasks.yml']['ls-lint']);
assert(issues.binaries['.moon/tasks/typescript.yml']['tsc']);
assert(issues.binaries['.moon/tasks/typescript.yml']['eslint']);
assert(issues.binaries['libs/b/moon.yml']['vitest']);
assert(issues.binaries['apps/a/moon.yml']['vite-node']);

assert(issues.devDependencies['package.json']['@moonrepo/cli']);
assert(issues.devDependencies['package.json']['vite-node']);
assert(issues.devDependencies['package.json']['eslint']);
assert(issues.devDependencies['libs/b/package.json']['vitest']);

assert(issues.files.has(join(cwd, 'libs/b/server/server.ts')));

assert.deepEqual(counters, {
...baseCounters,
files: 1,
devDependencies: 4,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Any chance you could add assertions about issues.devDependencies for those 4?

binaries: 5,
processed: 2,
total: 2,
});
});
Loading