juisy 2.0.0-beta.0 → 2.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli/cli.js +6 -4
- package/bin/cli/cmds/index.js +10 -10
- package/bin/cli/cmds/private/docs/generate-api.js +31 -0
- package/bin/cli/cmds/{docs → private/docs}/index.js +4 -6
- package/bin/cli/cmds/{print-globals.js → public/print-globals.js} +0 -1
- package/bin/scripts/prepare.js +22 -0
- package/dist/DataExporter.d.ts +6 -0
- package/dist/cli/CLIFactory.d.ts +48 -11
- package/dist/cli/Command.d.ts +23 -13
- package/dist/cli/GlobalSettings.schema.json +1 -0
- package/dist/cli/InterfaceUtils.d.ts +8 -2
- package/dist/cli/OutputUtils.d.ts +3 -3
- package/dist/cli/Plugin.d.ts +21 -0
- package/dist/cli/extract-usage.d.ts +7 -1
- package/dist/cli/index.d.ts +19 -6
- package/dist/cli/index.js +1160 -138
- package/dist/cli/plugins/command-handler-injections/augment.d.ts +29 -0
- package/dist/cli/{command-visitors → plugins/command-handler-injections/command-visitors}/command-handler-injections.d.ts +1 -1
- package/dist/cli/plugins/command-handler-injections/index.d.ts +3 -0
- package/dist/cli/plugins/command-meta/augment.d.ts +23 -0
- package/dist/cli/{command-visitors/get-command-meta.d.ts → plugins/command-meta/command-visitors/command-meta.d.ts} +1 -1
- package/dist/cli/plugins/command-meta/index.d.ts +3 -0
- package/dist/cli/plugins/default-command-fallbacks/augment.d.ts +3 -0
- package/dist/cli/plugins/default-command-fallbacks/command-visitors/default-command-fallbacks.d.ts +10 -0
- package/dist/cli/plugins/default-command-fallbacks/index.d.ts +3 -0
- package/dist/cli/plugins/load-env-file/augment.d.ts +9 -0
- package/dist/cli/plugins/load-env-file/index.d.ts +3 -0
- package/dist/cli/plugins/private-commands/augment.d.ts +6 -0
- package/dist/cli/{command-visitors → plugins/private-commands/command-visitors}/private-command.d.ts +1 -1
- package/dist/cli/plugins/private-commands/index.d.ts +3 -0
- package/dist/cli/plugins/register-changelog-command/augment.d.ts +110 -0
- package/dist/cli/plugins/register-changelog-command/cmds/index.d.ts +3 -0
- package/dist/cli/plugins/register-changelog-command/index.d.ts +3 -0
- package/dist/cli/plugins/register-docs-commands/augment.d.ts +18 -0
- package/dist/cli/plugins/register-docs-commands/cmds/generate-api.d.ts +3 -0
- package/dist/cli/plugins/register-docs-commands/cmds/generate-cli.d.ts +3 -0
- package/dist/cli/plugins/register-docs-commands/cmds/generate-readme.d.ts +3 -0
- package/dist/cli/plugins/register-docs-commands/cmds/index.d.ts +3 -0
- package/dist/cli/plugins/register-docs-commands/index.d.ts +3 -0
- package/dist/cli/plugins/register-git-hooks-commands/augment.d.ts +40 -0
- package/dist/cli/plugins/register-git-hooks-commands/cmds/index.d.ts +3 -0
- package/dist/cli/plugins/register-git-hooks-commands/cmds/reset.d.ts +3 -0
- package/dist/cli/plugins/register-git-hooks-commands/cmds/sync.d.ts +3 -0
- package/dist/cli/plugins/register-git-hooks-commands/index.d.ts +3 -0
- package/dist/cli/plugins/register-lint-commands/augment.d.ts +39 -0
- package/dist/cli/plugins/register-lint-commands/cmds/commit.d.ts +3 -0
- package/dist/cli/plugins/register-lint-commands/cmds/default.d.ts +3 -0
- package/dist/cli/plugins/register-lint-commands/cmds/markdown.d.ts +3 -0
- package/dist/cli/plugins/register-lint-commands/cmds/staged.d.ts +3 -0
- package/dist/cli/plugins/register-lint-commands/index.d.ts +3 -0
- package/dist/cli/plugins/register-lint-commands/settings.d.ts +11 -0
- package/dist/cli/plugins/register-lint-commands/types.d.ts +26 -0
- package/dist/cli/plugins/register-release-command/augment.d.ts +9 -0
- package/dist/cli/plugins/register-release-command/cmds/index.d.ts +3 -0
- package/dist/cli/plugins/register-release-command/index.d.ts +3 -0
- package/dist/cli/plugins/register-test-command/augment.d.ts +3 -0
- package/dist/cli/plugins/register-test-command/cmds/index.d.ts +3 -0
- package/dist/cli/plugins/register-test-command/index.d.ts +3 -0
- package/dist/cli/types.d.ts +73 -44
- package/dist/cli/utils.d.ts +3 -3
- package/dist/eject.d.ts +11 -4
- package/dist/index.d.ts +8 -2
- package/dist/index.js +80 -76
- package/dist/project-globals.d.ts +9 -0
- package/dist/templater/index.d.ts +6 -1
- package/dist/templater/index.js +27 -40
- package/dist/templater/markdown-templater/ReadmeTemplater.d.ts +28 -28
- package/dist/templater/markdown-templater/index.d.ts +3 -0
- package/dist/templater/types.d.ts +6 -0
- package/dist/utils/misc.d.ts +1 -1
- package/package.json +69 -55
- package/README.md +0 -211
- package/bin/cli/cmds/changelog.js +0 -41
- package/bin/cli/cmds/docs/generate-api.js +0 -22
- package/bin/cli/cmds/docs/generate-cli.js +0 -11
- package/bin/cli/cmds/docs/generate-readme.js +0 -11
- package/bin/cli/cmds/eject.js +0 -28
- package/bin/cli/cmds/git-hooks/index.js +0 -20
- package/bin/cli/cmds/git-hooks/reset.js +0 -48
- package/bin/cli/cmds/git-hooks/sync.js +0 -19
- package/bin/cli/cmds/release.js +0 -231
- package/bin/cli/lib/docs/generate-api-doc.js +0 -78
- package/bin/cli/lib/version/update-version.js +0 -52
- package/bin/scripts/commit-msg.js +0 -32
- package/bin/scripts/pre-commit.js +0 -24
- package/dist/cli/command-visitors/index.d.ts +0 -9
- package/src/index.js +0 -507
- package/template/CHANGELOG.md +0 -0
- package/template/bin/cli/cli.js +0 -27
- package/template/bin/cli/cmds/changelog.js +0 -71
- package/template/bin/cli/cmds/docs.js +0 -30
- package/template/bin/cli/cmds/docs_cmds/generate-api.js +0 -75
- package/template/bin/cli/cmds/docs_cmds/generate-readme.js +0 -51
- package/template/bin/cli/cmds/git-hooks.js +0 -30
- package/template/bin/cli/cmds/git_hooks_cmds/reset.js +0 -76
- package/template/bin/cli/cmds/git_hooks_cmds/sync.js +0 -44
- package/template/bin/cli/cmds/release.js +0 -219
- package/template/bin/cli/index.js +0 -7
- package/template/bin/cli/lib/docs/generate-api-doc.js +0 -33
- package/template/bin/cli/lib/release/generate-release-note.js +0 -3
- package/template/bin/cli/lib/version/update-version.js +0 -51
- package/template/bin/scripts/commit-msg.js +0 -42
- package/template/bin/scripts/pre-commit.js +0 -32
- package/template/docs/api/docs.config.js +0 -10
- package/template/docs/readme/config.js +0 -22
- package/template/docs/readme/readme.js +0 -70
- package/template/docs/readme/template.md +0 -53
- /package/bin/cli/cmds/{docs → private/docs}/lint.js +0 -0
- /package/bin/cli/cmds/{test.js → private/test.js} +0 -0
- /package/bin/cli/cmds/{squeeze.js → public/squeeze.js} +0 -0
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @hperchec/readme-generator Example configuration file
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
const path = require('path')
|
|
6
|
-
|
|
7
|
-
// Export configuration
|
|
8
|
-
module.exports = {
|
|
9
|
-
// Template path
|
|
10
|
-
templatePath: path.resolve(__dirname, './template.md'), // Default template file
|
|
11
|
-
// Output path
|
|
12
|
-
outputPath: path.resolve(__dirname, '../../'), // Your project root directory by default
|
|
13
|
-
// Output file name
|
|
14
|
-
outputName: 'README.md', // 'README.md' by default
|
|
15
|
-
// Path to ejs data file
|
|
16
|
-
ejsDataPath: path.resolve(__dirname, './readme.js'), // Default template ejs data file
|
|
17
|
-
// EJS options (see https://www.npmjs.com/package/ejs#options)
|
|
18
|
-
ejsOptions: {
|
|
19
|
-
async: true
|
|
20
|
-
/* your ejs options... */
|
|
21
|
-
}
|
|
22
|
-
}
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @hperchec/readme-generator Template EJS data example file
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
const markdownTable = require('markdown-table') // ! v3 not compatible, use v2
|
|
6
|
-
|
|
7
|
-
// Based on the package.json file, get some data and informations
|
|
8
|
-
const pkg = require('../../package.json')
|
|
9
|
-
const packageName = pkg.name
|
|
10
|
-
const packageUrl = `https://www.npmjs.com/package/${packageName}`
|
|
11
|
-
const dependencies = pkg.dependencies || {}
|
|
12
|
-
const devDependencies = pkg.devDependencies || {}
|
|
13
|
-
const peerDependencies = pkg.peerDependencies || {}
|
|
14
|
-
const author = pkg.author
|
|
15
|
-
const contributors = pkg.contributors || []
|
|
16
|
-
const license = pkg.license || 'Unknown'
|
|
17
|
-
const homepage = pkg.homepage
|
|
18
|
-
const projectUrl = pkg.repository.url
|
|
19
|
-
const issuesUrl = pkg.bugs.url
|
|
20
|
-
|
|
21
|
-
// Output a markdown formatted table from a js object
|
|
22
|
-
// Like:
|
|
23
|
-
// |name|version|
|
|
24
|
-
// |----|-------|
|
|
25
|
-
// | | |
|
|
26
|
-
function getMdDependencies (deps) {
|
|
27
|
-
return markdownTable([
|
|
28
|
-
[ 'name', 'version' ],
|
|
29
|
-
...(Object.entries(deps))
|
|
30
|
-
])
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* Return author link
|
|
35
|
-
* @param {Object} author
|
|
36
|
-
* @return {string}
|
|
37
|
-
*/
|
|
38
|
-
function getMdAuthor (author) {
|
|
39
|
-
return '[' + author.name + '](' + author.url + ')'
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* Return markdown list of persons
|
|
44
|
-
* @param {Array} contributors
|
|
45
|
-
* @return {String}
|
|
46
|
-
*/
|
|
47
|
-
function getMdContributors (contributors) {
|
|
48
|
-
let mdString = ''
|
|
49
|
-
contributors.forEach((person) => {
|
|
50
|
-
mdString += '- [' + person.name + '](' + person.url + ')\n'
|
|
51
|
-
})
|
|
52
|
-
return mdString
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Export data for readme file templating
|
|
57
|
-
*/
|
|
58
|
-
module.exports = {
|
|
59
|
-
packageName,
|
|
60
|
-
packageUrl,
|
|
61
|
-
projectUrl,
|
|
62
|
-
homepage,
|
|
63
|
-
issuesUrl,
|
|
64
|
-
dependencies: getMdDependencies(dependencies),
|
|
65
|
-
devDependencies: getMdDependencies(devDependencies),
|
|
66
|
-
peerDependencies: getMdDependencies(peerDependencies),
|
|
67
|
-
author: getMdAuthor(author),
|
|
68
|
-
contributors: getMdContributors(contributors),
|
|
69
|
-
license
|
|
70
|
-
}
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Awesome project
|
|
2
|
-
|
|
3
|
-
[]()
|
|
4
|
-
[](http://herve-perchec.com/)
|
|
5
|
-
|
|
6
|
-
**Table of contents**:
|
|
7
|
-
|
|
8
|
-
[[*TOC*]]
|
|
9
|
-
|
|
10
|
-
## 🚀 Get started
|
|
11
|
-
|
|
12
|
-
```sh
|
|
13
|
-
# Let's go!
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## 📙 Documentation
|
|
17
|
-
|
|
18
|
-
Please check the [documentation](https://www.npmjs.com/package/@hperchec/juisy)
|
|
19
|
-
|
|
20
|
-
## 🧱 Dependencies
|
|
21
|
-
|
|
22
|
-
<details>
|
|
23
|
-
<summary>Global</summary>
|
|
24
|
-
|
|
25
|
-
<%%= dependencies %>
|
|
26
|
-
|
|
27
|
-
</details>
|
|
28
|
-
|
|
29
|
-
<details>
|
|
30
|
-
<summary>Dev</summary>
|
|
31
|
-
|
|
32
|
-
<%%= devDependencies %>
|
|
33
|
-
|
|
34
|
-
</details>
|
|
35
|
-
|
|
36
|
-
<details>
|
|
37
|
-
<summary>Peer</summary>
|
|
38
|
-
|
|
39
|
-
<%%= peerDependencies %>
|
|
40
|
-
|
|
41
|
-
</details>
|
|
42
|
-
|
|
43
|
-
## ✍ Author
|
|
44
|
-
|
|
45
|
-
<%%= author %>
|
|
46
|
-
|
|
47
|
-
## 📄 License
|
|
48
|
-
|
|
49
|
-
<%%= license %>
|
|
50
|
-
|
|
51
|
-
----
|
|
52
|
-
|
|
53
|
-
Made with ❤ by <%%= author %>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|