Fix some more stuff (#101)

* chore: add license

* chore: set commitlint config

* chore: fix readme markdown

* feat: setup release please

* chore: simplify tsconfig

Author: marco-ippolito

.github/dependabot.yml

@@ -1,22 +1,10 @@
+# Basic set up for three package managers
+
 version: 2
 updates:
-  - package-ecosystem: 'npm'
-    directory: '/'
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
     schedule:
-      interval: 'weekly'
-      day: 'saturday'
-    versioning-strategy: 'increase'
-    labels:
-      - 'dependencies'
-    open-pull-requests-limit: 5
-    pull-request-branch-name:
-      separator: '-'
-    commit-message:
-      # cause a release for non-dev-deps
-      prefix: fix(deps)
-      # no release for dev-deps
-      prefix-development: chore(dev-deps)
-    ignore:
-      - dependency-name: '@salesforce/dev-scripts'
-      - dependency-name: '*'
-        update-types: ['version-update:semver-major']
+      interval: "weekly"

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: release
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created:  ${{ steps.release.outputs.release_created }}
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: googleapis/release-please-action@a02a34c4d625f9be7cb89156071d8567266a2445 # v4.2.0
+        id: release
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_GITHUB_TOKEN }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+  release:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm run build
+      - name: Create NPM release
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.0.0"
+}

LICENSE

@@ -0,0 +1,7 @@
+# Copyright (c) 2025 HeroDevs, Inc
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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

@@ -1,5 +1,4 @@
-@herodevs/cli
-=================
+# @herodevs/cli
 
 The HeroDevs CLI
 
@@ -11,7 +10,7 @@ The HeroDevs CLI
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
-# Usage
+## Usage
 <!-- usage -->
 ```sh-session
 $ npm install -g @herodevs/cli
@@ -25,7 +24,7 @@ USAGE
 ...
 ```
 <!-- usagestop -->
-# Commands
+## Commands
 <!-- commands -->
 * [`hd help [COMMAND]`](#hd-help-command)
 * [`hd plugins`](#hd-plugins)
@@ -43,13 +42,39 @@ USAGE
 * [`hd scan eol`](#hd-scan-eol)
 * [`hd scan sbom`](#hd-scan-sbom)
 
-## `hd help [COMMAND]`
+### `hd help [COMMAND]`
 
 Display help for hd.
 
 ```
+
+_See code: [src/commands/hello/index.ts](https://github.com/mdonnalley/mycli123/blob/v0.0.0/src/commands/hello/index.ts)_
+
+### `mycli123 hello world`
+
+Say hello world
+
+```text
 USAGE
-  $ hd help [COMMAND...] [-n]
+  $ mycli123 hello world
+
+DESCRIPTION
+  Say hello world
+
+EXAMPLES
+  $ mycli123 hello world
+  hello world! (./src/commands/hello/world.ts)
+```
+
+_See code: [src/commands/hello/world.ts](https://github.com/mdonnalley/mycli123/blob/v0.0.0/src/commands/hello/world.ts)_
+
+### `mycli123 help [COMMAND]`
+
+Display help for mycli123.
+
+```text
+USAGE
+  $ mycli123 help [COMMAND...] [-n]
 
 ARGUMENTS
   COMMAND...  Command to show help for.
@@ -63,7 +88,7 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.26/src/commands/help.ts)_
 
-## `hd plugins`
+### `hd plugins`
 
 List installed plugins.
 
@@ -86,7 +111,7 @@ EXAMPLES
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/index.ts)_
 
-## `hd plugins add PLUGIN`
+### `hd plugins add PLUGIN`
 
 Installs a plugin into hd.
 
@@ -133,7 +158,7 @@ EXAMPLES
     $ hd plugins add someuser/someplugin
 ```
 
-## `hd plugins:inspect PLUGIN...`
+### `hd plugins:inspect PLUGIN...`
 
 Displays installation properties of a plugin.
 
@@ -160,7 +185,7 @@ EXAMPLES
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/inspect.ts)_
 
-## `hd plugins install PLUGIN`
+### `hd plugins install PLUGIN`
 
 Installs a plugin into hd.
 
@@ -209,11 +234,11 @@ EXAMPLES
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/install.ts)_
 
-## `hd plugins link PATH`
+### `hd plugins link PATH`
 
 Links a plugin into the CLI for development.
 
-```
+```text
 USAGE
   $ hd plugins link PATH [-h] [--install] [-v]
 
@@ -240,7 +265,7 @@ EXAMPLES
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/link.ts)_
 
-## `hd plugins remove [PLUGIN]`
+### `hd plugins remove [PLUGIN]`
 
 Removes a plugin from the CLI.
 
@@ -266,7 +291,7 @@ EXAMPLES
   $ hd plugins remove myplugin
 ```
 
-## `hd plugins reset`
+### `hd plugins reset`
 
 Remove all user-installed and linked plugins.
 
@@ -281,7 +306,7 @@ FLAGS
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/reset.ts)_
 
-## `hd plugins uninstall [PLUGIN]`
+### `hd plugins uninstall [PLUGIN]`
 
 Removes a plugin from the CLI.
 
@@ -309,7 +334,7 @@ EXAMPLES
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/uninstall.ts)_
 
-## `hd plugins unlink [PLUGIN]`
+### `hd plugins unlink [PLUGIN]`
 
 Removes a plugin from the CLI.
 
@@ -335,7 +360,7 @@ EXAMPLES
   $ hd plugins unlink myplugin
 ```
 
-## `hd plugins update`
+### `hd plugins update`
 
 Update installed plugins.
 
@@ -353,11 +378,11 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
 
-## `hd report committers [FILE]`
+### `hd report committers [FILE]`
 
 Generate report of committers to a git repository
 
-```
+```text
 USAGE
   $ hd report committers [FILE] [-f] [-n <value>]
 
@@ -377,11 +402,11 @@ EXAMPLES
 
 _See code: [src/commands/report/committers.ts](https://github.com/herodevs/cli/blob/v2.0.0/src/commands/report/committers.ts)_
 
-## `hd report purls`
+### `hd scan eol [DIR]`
 
 Generate a list of purls from a sbom
 
-```
+```text
 USAGE
   $ hd report purls [-f <value>] [-d <value>] [-s] [-o json|csv]
 

commitlint.config.js

@@ -0,0 +1,6 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-max-line-length': [0, 'always'],
+  },
+};

package.json

@@ -6,6 +6,11 @@
   "bin": {
     "hd": "./bin/run.js"
   },
+  "bugs": "https://github.com/@herodevs/cli/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/herodevs/cli.git"
+  },
   "type": "module",
   "scripts": {
     "build": "shx rm -rf dist && tsc -b",
@@ -24,7 +29,6 @@
     "typecheck": "tsc --noEmit",
     "version": "oclif readme && git add README.md"
   },
-  "bugs": "https://github.com/@herodevs/cli/issues",
   "dependencies": {
     "@apollo/client": "^3.13.1",
     "@cyclonedx/cdxgen": "^11.2.0",
@@ -51,7 +55,8 @@
   "files": [
     "./bin",
     "./dist",
-    "./oclif.manifest.json"
+    "./oclif.manifest.json",
+    "LICENSE"
   ],
   "homepage": "https://github.com/@herodevs/cli",
   "keywords": [
@@ -77,9 +82,5 @@
       "prerun": "./dist/hooks/prerun/CommandContextHook"
     }
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/herodevs/cli.git"
-  },
   "types": "dist/index.d.ts"
 }

test/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "extends": "../tsconfig",
   "compilerOptions": {
-    "noEmit": true,
-    "module": "ESNext"
+    "noEmit": true
   }
 }

tsconfig.json

@@ -6,16 +6,11 @@
     "rootDir": "src",
     "strict": true,
     "target": "ESNext",
-    "allowJs": true,
-    "checkJs": true,
-    "esModuleInterop": true,
     "erasableSyntaxOnly": true,
     "rewriteRelativeImportExtensions": true,
     "verbatimModuleSyntax": true,
     "isolatedModules": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "typeRoots": ["node_modules/@types", "types"]
+    "skipLibCheck": true
   },
   "include": ["src/**/*", "types/**/*.d.ts"],
   "exclude": ["src/**/*.test.ts", "src/**/*.spec.ts", "test/**/*"]