Skip to content

Commit bad6f79

Browse files
Fix some more stuff (#101)
* chore: add license * chore: set commitlint config * chore: fix readme markdown * feat: setup release please * chore: simplify tsconfig
1 parent 0162f2a commit bad6f79

9 files changed

+98
-55
lines changed

.github/dependabot.yml

+7-19
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,10 @@
1+
# Basic set up for three package managers
2+
13
version: 2
24
updates:
3-
- package-ecosystem: 'npm'
4-
directory: '/'
5+
6+
# Maintain dependencies for GitHub Actions
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
59
schedule:
6-
interval: 'weekly'
7-
day: 'saturday'
8-
versioning-strategy: 'increase'
9-
labels:
10-
- 'dependencies'
11-
open-pull-requests-limit: 5
12-
pull-request-branch-name:
13-
separator: '-'
14-
commit-message:
15-
# cause a release for non-dev-deps
16-
prefix: fix(deps)
17-
# no release for dev-deps
18-
prefix-development: chore(dev-deps)
19-
ignore:
20-
- dependency-name: '@salesforce/dev-scripts'
21-
- dependency-name: '*'
22-
update-types: ['version-update:semver-major']
10+
interval: "weekly"

.github/workflows/release.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: release
2+
on:
3+
push:
4+
branches:
5+
- main
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
release-please:
13+
runs-on: ubuntu-latest
14+
outputs:
15+
release_created: ${{ steps.release.outputs.release_created }}
16+
permissions:
17+
contents: write
18+
pull-requests: write
19+
steps:
20+
- uses: googleapis/release-please-action@a02a34c4d625f9be7cb89156071d8567266a2445 # v4.2.0
21+
id: release
22+
with:
23+
token: ${{ secrets.RELEASE_PLEASE_GITHUB_TOKEN }}
24+
config-file: release-please-config.json
25+
manifest-file: .release-please-manifest.json
26+
27+
release:
28+
needs: release-please
29+
if: ${{ needs.release-please.outputs.release_created }}
30+
runs-on: ubuntu-latest
31+
permissions:
32+
contents: write
33+
id-token: write
34+
steps:
35+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
36+
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
37+
with:
38+
node-version-file: '.nvmrc'
39+
registry-url: 'https://registry.npmjs.org'
40+
- run: npm install
41+
- run: npm run build
42+
- name: Create NPM release
43+
run: npm publish --provenance --access public
44+
env:
45+
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.release-please-manifest.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "2.0.0"
3+
}

LICENSE

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Copyright (c) 2025 HeroDevs, Inc
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+21-22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
@herodevs/cli
2-
=================
1+
# @herodevs/cli
32

43
The HeroDevs CLI
54

@@ -11,7 +10,7 @@ The HeroDevs CLI
1110
* [Usage](#usage)
1211
* [Commands](#commands)
1312
<!-- tocstop -->
14-
# Usage
13+
## Usage
1514
<!-- usage -->
1615
```sh-session
1716
$ npm install -g @herodevs/cli
@@ -25,7 +24,7 @@ USAGE
2524
...
2625
```
2726
<!-- usagestop -->
28-
# Commands
27+
## Commands
2928
<!-- commands -->
3029
* [`hd help [COMMAND]`](#hd-help-command)
3130
* [`hd plugins`](#hd-plugins)
@@ -41,7 +40,7 @@ USAGE
4140
* [`hd report committers [FILE]`](#hd-report-committers-file)
4241
* [`hd scan eol [DIR]`](#hd-scan-eol-dir)
4342

44-
## `hd help [COMMAND]`
43+
### `hd help [COMMAND]`
4544

4645
Display help for hd.
4746

@@ -65,7 +64,7 @@ EXAMPLES
6564

6665
_See code: [src/commands/hello/index.ts](https://github.com/mdonnalley/mycli123/blob/v0.0.0/src/commands/hello/index.ts)_
6766

68-
## `mycli123 hello world`
67+
### `mycli123 hello world`
6968

7069
Say hello world
7170

@@ -83,7 +82,7 @@ EXAMPLES
8382

8483
_See code: [src/commands/hello/world.ts](https://github.com/mdonnalley/mycli123/blob/v0.0.0/src/commands/hello/world.ts)_
8584

86-
## `mycli123 help [COMMAND]`
85+
### `mycli123 help [COMMAND]`
8786

8887
Display help for mycli123.
8988

@@ -103,7 +102,7 @@ DESCRIPTION
103102

104103
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.26/src/commands/help.ts)_
105104

106-
## `hd plugins`
105+
### `hd plugins`
107106

108107
List installed plugins.
109108

@@ -126,7 +125,7 @@ EXAMPLES
126125

127126
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/index.ts)_
128127

129-
## `hd plugins add PLUGIN`
128+
### `hd plugins add PLUGIN`
130129

131130
Installs a plugin into hd.
132131

@@ -173,7 +172,7 @@ EXAMPLES
173172
$ hd plugins add someuser/someplugin
174173
```
175174

176-
## `hd plugins:inspect PLUGIN...`
175+
### `hd plugins:inspect PLUGIN...`
177176

178177
Displays installation properties of a plugin.
179178

@@ -200,7 +199,7 @@ EXAMPLES
200199

201200
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/inspect.ts)_
202201

203-
## `hd plugins install PLUGIN`
202+
### `hd plugins install PLUGIN`
204203

205204
Installs a plugin into hd.
206205

@@ -249,11 +248,11 @@ EXAMPLES
249248

250249
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/install.ts)_
251250

252-
## `hd plugins link PATH`
251+
### `hd plugins link PATH`
253252

254253
Links a plugin into the CLI for development.
255254

256-
```
255+
```text
257256
USAGE
258257
$ hd plugins link PATH [-h] [--install] [-v]
259258
@@ -280,7 +279,7 @@ EXAMPLES
280279

281280
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/link.ts)_
282281

283-
## `hd plugins remove [PLUGIN]`
282+
### `hd plugins remove [PLUGIN]`
284283

285284
Removes a plugin from the CLI.
286285

@@ -306,7 +305,7 @@ EXAMPLES
306305
$ hd plugins remove myplugin
307306
```
308307

309-
## `hd plugins reset`
308+
### `hd plugins reset`
310309

311310
Remove all user-installed and linked plugins.
312311

@@ -321,7 +320,7 @@ FLAGS
321320

322321
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/reset.ts)_
323322

324-
## `hd plugins uninstall [PLUGIN]`
323+
### `hd plugins uninstall [PLUGIN]`
325324

326325
Removes a plugin from the CLI.
327326

@@ -349,7 +348,7 @@ EXAMPLES
349348

350349
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/uninstall.ts)_
351350

352-
## `hd plugins unlink [PLUGIN]`
351+
### `hd plugins unlink [PLUGIN]`
353352

354353
Removes a plugin from the CLI.
355354

@@ -375,7 +374,7 @@ EXAMPLES
375374
$ hd plugins unlink myplugin
376375
```
377376

378-
## `hd plugins update`
377+
### `hd plugins update`
379378

380379
Update installed plugins.
381380

@@ -393,11 +392,11 @@ DESCRIPTION
393392

394393
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
395394

396-
## `hd report committers [FILE]`
395+
### `hd report committers [FILE]`
397396

398397
describe the command here
399398

400-
```
399+
```text
401400
USAGE
402401
$ hd report committers [FILE] [-f] [-n <value>]
403402
@@ -417,11 +416,11 @@ EXAMPLES
417416

418417
_See code: [src/commands/report/committers.ts](https://github.com/herodevs/cli/blob/v2.0.0/src/commands/report/committers.ts)_
419418

420-
## `hd scan eol [DIR]`
419+
### `hd scan eol [DIR]`
421420

422421
Scan a given directory
423422

424-
```
423+
```text
425424
USAGE
426425
$ hd scan eol [DIR] [--json] [-a] [-d <value>]
427426

commitlint.config.js

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
export default {
2+
extends: ['@commitlint/config-conventional'],
3+
rules: {
4+
'body-max-line-length': [0, 'always'],
5+
},
6+
};

package.json

+7-6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
"bin": {
77
"hd": "./bin/run.js"
88
},
9+
"bugs": "https://github.com/@herodevs/cli/issues",
10+
"repository": {
11+
"type": "git",
12+
"url": "https://github.com/herodevs/cli.git"
13+
},
914
"type": "module",
1015
"scripts": {
1116
"dev": "npm run build && ./bin/dev.js \"$@\"",
@@ -21,7 +26,6 @@
2126
"test": "node --disable-warning=ExperimentalWarning --experimental-strip-types --test \"test/**/*.test.ts\"",
2227
"version": "oclif readme && git add README.md"
2328
},
24-
"bugs": "https://github.com/@herodevs/cli/issues",
2529
"dependencies": {
2630
"@apollo/client": "^3.13.1",
2731
"@cyclonedx/cdxgen": "^11.2.0",
@@ -48,7 +52,8 @@
4852
"files": [
4953
"./bin",
5054
"./dist",
51-
"./oclif.manifest.json"
55+
"./oclif.manifest.json",
56+
"LICENSE"
5257
],
5358
"homepage": "https://github.com/@herodevs/cli",
5459
"keywords": [
@@ -74,9 +79,5 @@
7479
"prerun": "./dist/hooks/prerun/CommandContextHook"
7580
}
7681
},
77-
"repository": {
78-
"type": "git",
79-
"url": "https://github.com/herodevs/cli.git"
80-
},
8182
"types": "dist/index.d.ts"
8283
}

test/tsconfig.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"extends": "../tsconfig",
33
"compilerOptions": {
4-
"noEmit": true,
5-
"module": "ESNext"
4+
"noEmit": true
65
}
76
}

tsconfig.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,11 @@
66
"rootDir": "src",
77
"strict": true,
88
"target": "ESNext",
9-
"allowJs": true,
10-
"checkJs": true,
11-
"esModuleInterop": true,
129
"erasableSyntaxOnly": true,
1310
"rewriteRelativeImportExtensions": true,
1411
"verbatimModuleSyntax": true,
1512
"isolatedModules": true,
16-
"skipLibCheck": true,
17-
"forceConsistentCasingInFileNames": true,
18-
"typeRoots": ["node_modules/@types", "types"]
13+
"skipLibCheck": true
1914
},
2015
"include": ["src/**/*", "types/**/*.d.ts"],
2116
"exclude": ["src/**/*.test.ts", "src/**/*.spec.ts", "test/**/*"]

0 commit comments

Comments
 (0)