Skip to content

Commit

Permalink
Add prefer-no-dependencies rule
Browse files Browse the repository at this point in the history
Closes #134
  • Loading branch information
tclindner committed Nov 10, 2019
1 parent 678ada8 commit e49c268
Show file tree
Hide file tree
Showing 4 changed files with 121 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/rules.md
Expand Up @@ -138,4 +138,5 @@ Rules allow npm-package-json-lint to be fully customizable. npm-package-json-lin
> Generates an error if the node is present
* [prefer-no-engineStrict](rules/disallowed-nodes/prefer-no-engineStrict)
* [prefer-no-dependencies](rules/disallowed-nodes/prefer-no-dependencies)
* [prefer-no-devDependencies](rules/disallowed-nodes/prefer-no-devDependencies)
51 changes: 51 additions & 0 deletions docs/rules/disallowed-nodes/prefer-no-dependencies.md
@@ -0,0 +1,51 @@
---
id: prefer-no-dependencies
title: prefer-no-dependencies
---

Enabling this rule will result in an error being generated if `dependencies` is present.

## Example .npmpackagejsonlintrc configuration

```json
{
"rules": {
"prefer-no-dependencies": "error"
}
}
```

With exceptions

```json
{
"rules": {
"prefer-no-dependencies": ["error", {
"exceptions": ["myModule"]
}]
}
}
```


## Rule Details

### *Incorrect* example(s)

```json
{
"dependencies": "dummy-value"
}
```

### *Correct* example(s)

```json
{
"prefer-no-dependencies": "error"
}
```

## History

* Introduced in version 4.1.0
20 changes: 20 additions & 0 deletions src/rules/prefer-no-dependencies.js
@@ -0,0 +1,20 @@
const {exists} = require('../validators/property');
const LintIssue = require('../LintIssue');

const lintId = 'prefer-no-dependencies';
const nodeName = 'dependencies';
const message = 'dependencies should not be defined';
const ruleType = 'optionalObject';

const lint = (packageJsonData, severity) => {
if (exists(packageJsonData, nodeName)) {
return new LintIssue(lintId, severity, nodeName, message);
}

return true;
};

module.exports = {
lint,
ruleType
};
49 changes: 49 additions & 0 deletions test/unit/rules/prefer-no-dependencies.test.js
@@ -0,0 +1,49 @@
const ruleModule = require('../../../src/rules/prefer-no-dependencies');
const property = require('../../../src/validators/property');

const {lint, ruleType} = ruleModule;

jest.mock('../../../src/validators/property');

const nodeName = 'dependencies';

describe('prefer-no-dependencies Unit Tests', () => {
describe('a rule type value should be exported', () => {
test('it should equal "optionalObject"', () => {
expect(ruleType).toStrictEqual('optionalObject');
});
});

describe('when package.json has dependencies node', () => {
test('LintIssue object should be returned', () => {
property.exists.mockReturnValue(true);

const packageJsonData = {
dependencies: 'dummy-value'
};
const response = lint(packageJsonData, 'error');

expect(response.lintId).toStrictEqual('prefer-no-dependencies');
expect(response.severity).toStrictEqual('error');
expect(response.node).toStrictEqual(nodeName);
expect(response.lintMessage).toStrictEqual('dependencies should not be defined');

expect(property.exists).toHaveBeenCalledTimes(1);
expect(property.exists).toHaveBeenCalledWith(packageJsonData, nodeName);
});
});

describe('when package.json does not have node', () => {
test('true should be returned', () => {
property.exists.mockReturnValue(false);

const packageJsonData = {};
const response = lint(packageJsonData, 'error');

expect(response).toBe(true);

expect(property.exists).toHaveBeenCalledTimes(1);
expect(property.exists).toHaveBeenCalledWith(packageJsonData, nodeName);
});
});
});

0 comments on commit e49c268

Please sign in to comment.