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.

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

fix(linter): dependency checks should respect pnpm workspace versions #26709

Merged
merged 1 commit into from
Jun 27, 2024
Merged

fix(linter): dependency checks should respect pnpm workspace versions #26709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
155 changes: 106 additions & 49 deletions packages/eslint-plugin/src/rules/dependency-checks.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1580,68 +1580,125 @@ describe('Dependency checks (eslint)', () => {
- external1"
`);
});
});

it('should require swc if @nx/js:swc executor', () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This test has been moved into describe block from outside

const packageJson = {
name: '@mycompany/liba',
dependencies: {
external1: '^16.0.0',
},
};
it('should not report * and workspace:*', () => {
const packageJson = {
name: '@mycompany/liba',
dependencies: {
external1: '*',
external2: 'workspace:*',
},
};

const swcrc = {
jsc: {
externalHelpers: true,
},
};
const fileSys = {
'./libs/liba/package.json': JSON.stringify(packageJson, null, 2),
'./libs/liba/src/index.ts': '',
'./package.json': JSON.stringify(rootPackageJson, null, 2),
};
vol.fromJSON(fileSys, '/root');

const fileSys = {
'./libs/liba/package.json': JSON.stringify(packageJson, null, 2),
'./libs/liba/src/index.ts': '',
'./libs/liba/.swcrc': JSON.stringify(swcrc, null, 2),
'./package.json': JSON.stringify(rootPackageJson, null, 2),
};
vol.fromJSON(fileSys, '/root');

const failures = runRule(
{},
`/root/libs/liba/package.json`,
JSON.stringify(packageJson, null, 2),
{
nodes: {
liba: {
name: 'liba',
type: 'lib',
data: {
root: 'libs/liba',
targets: {
build: {
executor: '@nx/js:swc',
options: {},
const failures = runRule(
{},
`/root/libs/liba/package.json`,
JSON.stringify(packageJson, null, 2),
{
nodes: {
liba: {
name: 'liba',
type: 'lib',
data: {
root: 'libs/liba',
targets: {
build: {},
},
},
},
},
externalNodes,
dependencies: {
liba: [
{ source: 'liba', target: 'npm:external1', type: 'static' },
{ source: 'liba', target: 'npm:external2', type: 'static' },
],
},
},
externalNodes,
{
liba: [
createFile(`libs/liba/src/main.ts`, [
'npm:external1',
'npm:external2',
]),
createFile(`libs/liba/package.json`, [
'npm:external1',
'npm:external2',
]),
],
}
);
expect(failures.length).toEqual(0);
});

it('should require swc if @nx/js:swc executor', () => {
const packageJson = {
name: '@mycompany/liba',
dependencies: {
liba: [{ source: 'liba', target: 'npm:external1', type: 'static' }],
external1: '^16.0.0',
},
},
{
liba: [
createFile(`libs/liba/src/main.ts`, ['npm:external1']),
createFile(`libs/liba/package.json`, ['npm:external1']),
],
}
);
expect(failures.length).toEqual(1);
expect(failures[0].message).toMatchInlineSnapshot(`
};

const swcrc = {
jsc: {
externalHelpers: true,
},
};

const fileSys = {
'./libs/liba/package.json': JSON.stringify(packageJson, null, 2),
'./libs/liba/src/index.ts': '',
'./libs/liba/.swcrc': JSON.stringify(swcrc, null, 2),
'./package.json': JSON.stringify(rootPackageJson, null, 2),
};
vol.fromJSON(fileSys, '/root');

const failures = runRule(
{},
`/root/libs/liba/package.json`,
JSON.stringify(packageJson, null, 2),
{
nodes: {
liba: {
name: 'liba',
type: 'lib',
data: {
root: 'libs/liba',
targets: {
build: {
executor: '@nx/js:swc',
options: {},
},
},
},
},
},
externalNodes,
dependencies: {
liba: [{ source: 'liba', target: 'npm:external1', type: 'static' }],
},
},
{
liba: [
createFile(`libs/liba/src/main.ts`, ['npm:external1']),
createFile(`libs/liba/package.json`, ['npm:external1']),
],
}
);
expect(failures.length).toEqual(1);
expect(failures[0].message).toMatchInlineSnapshot(`
"The "liba" project uses the following packages, but they are missing from "dependencies":
- @swc/helpers"
`);
expect(failures[0].line).toEqual(3);
expect(failures[0].line).toEqual(3);
});
});

function createFile(f: string, deps?: FileDataDependency[]): FileData {
Expand Down
1 change: 1 addition & 0 deletions packages/eslint-plugin/src/rules/dependency-checks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ export default ESLintUtils.RuleCreator(
packageRange.startsWith('file:') ||
npmDependencies[packageName] === '*' ||
packageRange === '*' ||
packageRange === 'workspace:*' ||
satisfies(npmDependencies[packageName], packageRange, {
includePrerelease: true,
})
Expand Down