Skip to content

Commit 809e46b

Browse files
db-developerdb-developer
committed
update documentation
1 parent 884f2e5 commit 809e46b

File tree

4 files changed

+140
-7
lines changed

4 files changed

+140
-7
lines changed

‎README.md‎

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,50 @@ Of cause, the task can be integrated into any complex build process.
4747

4848
## usage ##
4949

50-
documentation to be completed.
51-
Currently this plugin supports all commandline options of
52-
[check-outdated](https://www.npmjs.com/package/check-outdated)
53-
54-
Use grunt "options" to pass options to
55-
[check-outdated](https://www.npmjs.com/package/check-outdated).
56-
Do not use camel case (Don't ask - I simply fricking hate that :-))
50+
The following examples assume that the grunt plugin 'load-grunt-config' is used.
51+
Alternatively, the code can of course be integrated into the 'gruntfile.js' file.
52+
53+
For a better understanding of 'checkoutdated' options, pls. visit
54+
[check-outdated](https://www.npmjs.com/package/check-outdated)
55+
56+
Options hidden by a comment show default values.
57+
58+
```javascript
59+
// file check_outdated.js
60+
module.exports = function ( grunt, options ) {
61+
return {
62+
always: { // this is a grunt multitask, so define a target.
63+
options: {
64+
// cwd: process.cwd(), // set a working directory - defaults to process.cwd()
65+
// dryrun: false, // dry run - do nothing just print out the cmd line
66+
// quiet false, // ... shut up! (no good idea if task fails)
67+
/* node: { // node options
68+
exec: {string}, // set your node executable - defaults to: process.execPath
69+
opts: {Array<string>} // array of node options
70+
}, */
71+
checkoutdated: { // mirrors options of [check-outdated](https://www.npmjs.com/package/check-outdated)
72+
ignore: {
73+
// prereleases: false, // --ignore-pre-releases
74+
// Don't recommend to update to the latest version, if it contains a hyphen
75+
// devdependencies: false, // --ignore-dev-dependencies
76+
// Do not warn if devDependencies are outdated.
77+
packages: [ "webpack" ] // --ignore-packages
78+
}, // Ignore the listed packages, even if they are outdated.
79+
columns: [ // --columns
80+
"name" , // Defines which columns should be shown in which order.
81+
"current", // [Available columns](https://www.npmjs.com/package/check-outdated#available-columns)
82+
"wanted",
83+
"latest"
84+
],
85+
// opts: {Array<string>} // grunt-plugin specific: In case check-outdated is newer than
86+
// grunt-check-outdated, you may manually add new options to this
87+
// array. The arrays contents are appended to the end of the call,
88+
// created by this plugin (which can be verified using --dryrun)
89+
// depth: false, // --depth <n> Max depth for checking dependency tree
90+
// global: false // --global Check packages in the global install prefix
91+
}
92+
}
93+
}
94+
};
95+
};
96+
```

‎docs/contributing.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## contributing guidelines ##
2+
3+
By contributing (aka sending in pull requests) you certify that:
4+
5+
* Your Contributions are either:
6+
1. Created in whole or in part by you and you have the right to submit it under the designated license; or
7+
2. Based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the designated license; or
8+
3. Provided directly to you by some other person who certified (1) or (2) and you have not modified them.
9+
* You understand and agree that the Project 'grunt-angularjson-append-projects' and your Contributions are public and that a record of the Contributions (including all metadata and personal information you submit with them) is maintained indefinitely and may be redistributed consistent with the projects's policies and the requirements of the MIT license where they are relevant.
10+
* You are granting your Contributions to slashlib.org, Dirk Brenckmann under the terms of the license as noted in the project’s repository.
11+
12+
### contributing ###
13+
14+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
15+
16+
### pull request process ###
17+
18+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
19+
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
20+
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
21+
4. Accepted Pull Request are mereged in for you, by the project owner.

‎docs/frameworks.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
[Back to README.md](../README.md)
2+
3+
## frameworks ##
4+
5+
### [grunt](https://gruntjs.com "Homepage of grunt") ###
6+
7+
A framework for getting tasks done. Tasks can be testing, building, packaging, whatever.
8+
9+
### [check-outdated](https://www.npmjs.com/package/check-outdated) ###
10+
11+
Ensures that your dependencies are up-to-date, otherwise the process is terminated with status code 1.
12+
13+
This is an improved version of npm outdated, which can be used in build-pipelines, pre-publish scripts (npm) or pre-commit hook (Git) to make sure all the used dependencies are up-to-date.
14+
15+
### [eslint](https://eslint.org/) ###
16+
17+
Find Problems
18+
ESLint statically analyzes your code to quickly find problems. ESLint is built into most text editors and you can run ESLint as part of your continuous integration pipeline.
19+
20+
Fix Automatically
21+
Many problems ESLint finds can be automatically fixed. ESLint fixes are syntax-aware so you won't experience errors introduced by traditional find-and-replace algorithms.
22+
23+
Customize
24+
Preprocess code, use custom parsers, and write your own rules that work alongside ESLint's built-in rules. You can customize ESLint to work exactly the way you need it for your project.
25+
26+
### [mocha](https://mochajs.org/) ###
27+
28+
Testing framework.
29+
30+
### [expect.js](https://github.com/Automattic/expect.js) ###
31+
32+
Assertion framework for unit testing.
33+
34+
### [nyc (was:istanbul)](https://istanbul.js.org/) ###
35+
36+
Code coverage. [See code coverage for mocha](https://istanbul.js.org/docs/tutorials/mocha/)
37+
38+
### [rollup.js](https://rollupjs.org/) ###
39+
Part of the plugins build process, used for code bundling.
40+
41+
### [webpack.js](https://webpack.js.org/) ###
42+
Alternative code bundler. Feel free to switcg the build process, if you prefer webpack.
43+
Be aware, this might need adjustments or fixes. It has not been tested for a while :)
44+
45+
### [source-map-support](https://www.npmjs.com/package/source-map-support) ###
46+
This module provides source map support for stack traces in node via the V8 stack trace API.

‎docs/grunt.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[Back to README.md](../README.md)
2+
3+
## make targets of gruntfile.js and package.json ##
4+
5+
This guide assumes, that you are familiar with the use of [git](https://git-scm.com/ "Homepage of GIT"), [npm](https://npmjs.com "Homepage of npm") and [grunt](https://gruntjs.com "Homepage of grunt").
6+
7+
1. git fork [grunt-check-outdated plugin for grunt](https://github.com/db-developer/grunt-check-outdated) (https://github.com/db-developer/grunt-check-outdated.git)
8+
2. cd into forked grunt-check-outdated directory
9+
3. open a shell
10+
4. make sure your environment knows about the paths to nodejs
11+
5. run <code>npm install</code>
12+
13+
### testing & coverage ###
14+
15+
The code of grunt-check-outdated can be tested. A [mocha](https://mochajs.org/ "Homepage of mocha")/[istanbul](https://istanbul.js.org/ "Homepage of istanbul") testsuite is provided. See directory <code>test</code>.
16+
Open a shell to run the tests, make sure the environment is set, cd into the forked grunt-check-outdated directory and run: <code>grunt test</code>
17+
18+
With testing (see above) code coverage is available. The results can be found in the dist/coverage folder.
19+
20+
### building ###
21+
22+
Building can be run by <code>grunt all</code> and requires the build directory.
23+
After a successful build, all resulting files are located in the directory <code>dist</code>.
24+
25+
### feedback ###
26+
Do you feel this guide is missing essential information? Found any typos or amused by the translation? Please do not hesitate to file an issue on github!

0 commit comments

Comments
 (0)