UNPKG

4.71 kBMarkdownView Raw
1## suf-cli
2
3suf-cli is a utility cli for automating readme stuff, like adding a license.
4
5<span id="BADGE_GENERATION_MARKER_0"></span>
6[![npmV](https://img.shields.io/npm/v/suf-cli)](https://www.npmjs.com/package/suf-cli) [![min](https://img.shields.io/bundlephobia/min/suf-cli)](https://bundlephobia.com/result?p=suf-cli) [![install](https://badgen.net/packagephobia/install/suf-cli)](https://packagephobia.now.sh/result?p=suf-cli) [![githubLastCommit](https://img.shields.io/github/last-commit/TheRealSyler/suf-cli)](https://github.com/TheRealSyler/suf-cli) [![circleci](https://img.shields.io/circleci/build/github/TheRealSyler/suf-cli)](https://app.circleci.com/github/TheRealSyler/suf-cli/pipelines) [![codecov](https://codecov.io/gh/TheRealSyler/suf-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/TheRealSyler/suf-cli)
7<span id="BADGE_GENERATION_MARKER_1"></span>
8
9## Usage
10
11```bash
12suf
13```
14
15this cli works by reading the `suf.config(.json or .ts)` file, every cli module has its section in the config file, if you call the cli without any arguments it will ask you to create a config or it executes all modules present in the config, to add a module just execute the command for that module.
16
17> INFO: All arguments can start with - or --, but i would recommend to just use letters.
18
19| Command | |
20| ------------------------------- | ------------------------- |
21| `a` \| `all` | Calls all modules. |
22| `b` \| `badges` | Calls the badges module. |
23| `t` \| `ts` \| `d.ts` \| `docs` | Calls the tsDoc module. |
24| `l` \| `licence` | Calls the license module. |
25| `h` \| `help` | Displays this Message. |
26
27<span id="DOC_GENERATION_MARKER_0"></span>
28
29# Docs
30
31- **[badgeTypes](#badgetypes)**
32
33 - [BadgeTypes](#badgetypes)
34 - [BadgeLinkTypes](#badgelinktypes)
35
36### badgeTypes
37
38##### BadgeTypes
39
40```ts
41interface BadgeTypes {
42 /** circleCi build. */
43 circleci: '/circleci/build/github/<GITHUB>/<REPO>';
44 /** codecov percentage. */
45 codecov: '/gh/<GITHUB>/<REPO>/branch/master/graph/badge.svg';
46 /** Vscode Extension Version. */
47 vscV: '/visual-studio-marketplace/v/<VSCODE>';
48 /** Vscode Extension downloads. */
49 vscD: '/visual-studio-marketplace/d/<VSCODE>';
50 /** Vscode Extension installs. */
51 vscI: '/visual-studio-marketplace/i/<VSCODE>';
52 /** Vscode Extension ratings. */
53 vscR: '/visual-studio-marketplace/r/<VSCODE>';
54 /** Bundlephobia Min. */
55 min: '/bundlephobia/min/<NAME>';
56 /** Bundlephobia Minzip. */
57 minzip: '/bundlephobia/minzip/<NAME>';
58 /** Packagephobia Install. */
59 install: '/packagephobia/install/<NAME>';
60 /** Packagephobia Publish. */
61 publish: '/packagephobia/publish/<NAME>';
62 /** Npm Version. */
63 npmV: '/npm/v/<NAME>';
64 /** Npm Weekly Downloads. */
65 npmDW: '/npm/dw/<NAME>';
66 /** Npm Monthly Downloads. */
67 npmDM: '/npm/dm/<NAME>';
68 /** Npm Yearly Downloads. */
69 npmDY: '/npm/dy/<NAME>';
70 /** Npm Total Downloads. */
71 npmDT: '/npm/dt/<NAME>';
72 /** Npm Types. */
73 npmTypes: '/npm/types/<NAME>';
74 /** Npm License. */
75 npmLicense: '/npm/license/<NAME>';
76 /** Npm Node. */
77 npmNode: '/npm/node/<NAME>';
78 /** Npm Dependents. */
79 npmDep: '/npm/dependents/<NAME>';
80 /** GitHub Followers. */
81 githubFollowers: '/github/followers/<GITHUB>';
82 /** GitHub Forks. */
83 githubForks: '/github/forks/<GITHUB>/<REPO>';
84 /** GitHub Starts. */
85 githubStars: '/github/stars/<GITHUB>/<REPO>';
86 /** GitHub Issues. */
87 githubIssues: '/github/issues/<GITHUB>/<REPO>';
88 /** GitHub Last Commit. */
89 githubLastCommit: '/github/last-commit/<GITHUB>/<REPO>';
90}
91```
92
93##### BadgeLinkTypes
94
95```ts
96interface BadgeLinkTypes {
97 /** Npm package. */
98 npm: 'https://www.npmjs.com/package/<NAME>';
99 /** Github Repo. */
100 github: 'https://github.com/<GITHUB>/<REPO>';
101 /** circleCi Repo Pipelines. */
102 circleci: 'https://app.circleci.com/github/<GITHUB>/<REPO>/pipelines';
103 /** Visual Studio marketplace. */
104 vscode: 'https://marketplace.visualstudio.com/items?itemName=<VSCODE>';
105 /** Bundlephobia Link. */
106 bundle: 'https://bundlephobia.com/result?p=<NAME>';
107 /** Packagephobia Link. */
108 package: 'https://packagephobia.now.sh/result?p=<NAME>';
109 /** codecov Link. */
110 codecov: 'https://codecov.io/gh/<GITHUB>/<REPO>';
111}
112```
113
114_Generated with_ **[suf-cli](https://www.npmjs.com/package/suf-cli)**
115<span id="DOC_GENERATION_MARKER_1"></span>
116
117<span id="LICENSE_GENERATION_MARKER_0"></span>
118Copyright (c) 2019 Leonard Grosoli Licensed under the MIT license.
119<span id="LICENSE_GENERATION_MARKER_1"></span>