Skip to content

Commit

Permalink
fix(linter): dependency checks should respect pnpm workspace versions (
Browse files Browse the repository at this point in the history
…nrwl#26709)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes nrwl#26707
  • Loading branch information
meeroslav authored Jun 27, 2024
1 parent 5843068 commit 7f8bb4b
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 49 deletions.
155 changes: 106 additions & 49 deletions packages/eslint-plugin/src/rules/dependency-checks.spec.ts
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', () => {
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
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

0 comments on commit 7f8bb4b

Please sign in to comment.