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

feature/node-support #23

Closed
wants to merge 2 commits into from
Closed
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
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ $ npm install add-dependencies [-g]

### Usage

Run:
Run (for `nodejs` see Example):

```sh
$ add-dependencies [package_file] <dependencies> [target] [--no-overwrite]
Expand Down Expand Up @@ -46,3 +46,31 @@ or with `npx`:
```sh
$ npx add-dependencies /home/user/project/package.json [email protected] [email protected] redux eslint --dev
```

or via nodejs

```js
const npmAdd = require('add-dependencies');
phyzical marked this conversation as resolved.
Show resolved Hide resolved
```
OR

```js
// Note: to use import you must have `"type": "module"` in your projects package.json
import npmAdd from 'add-dependencies';
```

THEN

```js
const dependencies = [
'package1',
'package2',
'package3',
];
const target = npmAdd.CONSTANTS.DEPENDENCIES;
phyzical marked this conversation as resolved.
Show resolved Hide resolved
const overwrite = false;
const packageFilePath = 'package.json';
new npmAdd(dependencies, target, overwrite, packageFilePath)
.run()
.then(() => console.log('completed'));
```
15 changes: 15 additions & 0 deletions cli-index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env node

const AddDependencies = require('./lib/AddDependencies');

console.log(
'\x1b[33m%s\x1b[0m',
'This script adds dependencies (latest or specified versions) to the package.json file skipping the installation process.'
);

const app = new AddDependencies();

app.run().catch((error) => {
console.error('\x1b[31m%s\x1b[0m', error);
process.exit(1);
});
10 changes: 1 addition & 9 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
#!/usr/bin/env node
const AddDependencies = require('./lib/AddDependencies');

console.log('\x1b[33m%s\x1b[0m', 'This script adds dependencies (latest or specified versions) to the package.json file skipping the installation process.');

const app = new AddDependencies();

app.addDependencies().then(app.saveToPackage.bind(app)).catch((error) => {
console.error('\x1b[31m%s\x1b[0m', error);
process.exit(1);
});
module.exports = require('./lib/AddDependencies');
37 changes: 32 additions & 5 deletions lib/AddDependencies.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,17 @@ const semver = require('semver');
const Files = require('./Files');

class AddDependencies {
constructor() {
constructor(
dependencies = [],
target = 'dependencies',
overwrite = true,
packageFilePath = './package.json'
) {
this.result = {};
this.dependencies = [];
this.target = 'dependencies';
this.overwrite = true;
this.packageFilePath = './package.json';
this.dependencies = dependencies;
this.target = target;
this.overwrite = overwrite;
this.packageFilePath = packageFilePath;
}

addDependencies() {
Expand Down Expand Up @@ -59,7 +64,20 @@ class AddDependencies {
return Promise.all(this.dependencies.map((dep) => this.runNpmShow(dep)));
}

run() {
return this.addDependencies().then(() => this.saveToPackage());
}

runNpmShow(dep) {
if (!dep) {
console.error(
'\x1b[31m%s\x1b[0m',
`No Dependency Provided to runNpmShow()`
);

return new Promise((resolve) => resolve());
phyzical marked this conversation as resolved.
Show resolved Hide resolved
}

const depSplit = dep.split('@');
const [depName, depVersion] = dep.charAt(0) !== '@' ? depSplit : [`@${depSplit[1]}`, depSplit[2]];

Expand Down Expand Up @@ -158,6 +176,15 @@ class AddDependencies {
process.exit(1);
});
}

static get CONSTANTS() {
return {
DEPENDENCIES: 'dependencies',
DEV_DEPENDENCIES: 'devDependencies',
PEER_DEPENDENCIES: 'peerDependencies',
OPTIONAL_DEPENDENCIES: 'optionalDependencies',
};
}
}

module.exports = AddDependencies;
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
"license": "MIT",
"preferGlobal": true,
"bin": {
"add-dependencies": "index.js"
"add-dependencies": "cli-index.js"
},
"dependencies": {
"npm-run": "^5.0.1",
"semver": "^6.3.0"
}
}
}