feat: Expand CLI commands (#200)

Author: LekoArts

.changeset/blue-shirts-hammer.md

@@ -0,0 +1,9 @@
+---
+"secco": patch
+---
+
+Various small bug fixes:
+
+- When `dist/` was in the `files` array of `package.json` it didn't correctly copy over files inside the `dist` directory
+- When `--scan-once` and `--force-verdaccio` were used together a warning was thrown about an ungraceful exit. For this codepath any cleanup tasks are run before exiting now. The warning won't show.
+- The `init` command ran the whole main function while it should only run the Enquirer prompt. This is fixed now.

.changeset/fast-rats-look.md

@@ -0,0 +1,16 @@
+---
+"secco": minor
+---
+
+The CLI got more functionality!
+
+- Add `-s` alias for `--scan-once` and `-f` for `--force-verdaccio`
+- Add `--source` and `--yes` flag for `secco init`, making it possible to run the init command in non-interactive mode
+
+    For example, this command will create a `.seccorc` file with the given source path:
+
+    ```bash
+    secco init --source=/absolute/path --yes
+    ```
+
+    If you don't provide the `--yes` flag you'll need to confirm the prompt.

README.md

@@ -66,19 +66,21 @@ Here's an overview of all available commands and flags:
 Usage: secco <command>
 
 Commands:
-  secco init                        Initialize a new .seccorc file
+  secco                             Scan destination and copy files from source  [default]
   secco packages [packageNames...]  Specify list of packages you want to link
+  secco init                        Initialize a new .seccorc file
 
 Options:
-  --help             Show help
-  --version          Show version number
-  --scan-once        Scan source once and do not start file watching
-  --force-verdaccio  Disable file copying/watching and force usage of Verdaccio
-  --verbose          Output verbose logging
+      --help             Show help  [boolean]
+      --version          Show version number  [boolean]
+  -s, --scan-once        Scan source once and do not start file watching  [boolean] [default: false]
+  -f, --force-verdaccio  Disable file copying/watching and force usage of Verdaccio  [boolean] [default: false]
+      --verbose          Output verbose logging  [boolean] [default: false]
 
 Examples:
-  secco                     Scan destination and copy files from source
-  secco packages ars aurea  Copy specified packages from source to destination
+  secco                                     Scan destination and copy files from source
+  secco packages ars aurea                  Copy specified packages from source to destination
+  secco init --source=/absolute/path --yes  Create a .seccorc file in the current dir with the provided source path without any prompts
 ```
 
 ## Documentation

docs/src/content/docs/guide/learn-secco.mdx

@@ -64,8 +64,9 @@ Ensure that the installation was successful by running `secco --help`. You shoul
 Usage: secco <command>
 
 Commands:
-  secco init                        Initialize a new .seccorc file
+  secco                             Scan destination and copy files from source  [default]
   secco packages [packageNames...]  Specify list of packages you want to link
+  secco init                        Initialize a new .seccorc file
 ```
 
 ## How to use secco

docs/src/content/docs/reference/commands.md

@@ -9,6 +9,17 @@ sidebar:
 
 Run this command inside your destination folder. You'll be asked questions about your source folder and at the end of the questionnaire a new `.seccorc` config file will be created.
 
+By default, the `secco init` command is an interactive prompt. However, if you want to use it in non-interactive environments you can provide both `--source` and `--yes` flags.
+
+```shell
+secco init --source=/absolute-path/to/directory --yes
+```
+
+**Optional flags:**
+
+- `--source`: Absolute path to the source directory
+- `--yes`: Skip confirmation prompts
+
 ## `secco`
 
 `secco` will scan your destination's `package.json` file and compare it with the available packages inside your source. It'll then copy over all changes into your destination's `node_modules` folder. Additionally, a watch task is started to continue copying over changes. Packages that have [`"private": true`](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#private) set will be ignored.

docs/src/content/docs/reference/flags.md

@@ -5,26 +5,34 @@ sidebar:
   order: 99999
 ---
 
-These are the flags that you can use with any command.
+These are the flags that you can use throughout the CLI. If not noted otherwise, you can use them with every command.
 
 ## `--help`
 
-Shows the help menu of `secco`
+Shows the help menu of `secco`. You can also show help menus of subcommands, e.g. `secco packages --help`.
 
 ## `--version`
 
-Displays the current version of `secco`
+Displays the current version of `secco`.
+
+## `--verbose`
+
+Output additional debug logs and more information.
 
 ## `--scan-once`
 
+- **Alias:** `-s`
+
+- **Commands:** `secco`, `secco packages`
+
 By default `secco` starts a watch script to listen for changes. If you want to disable this behavior, use `--scan-once`. This way `secco` will do an initial scan, copy the changes, and then quit.
 
 This is useful for CI environments as you can e.g. set up automated test sites with latest code changes. See the [CI guide](/guide/continuous-integration/) for more information.
 
 ## `--force-verdaccio`
 
-Disable the copying of files into `node_modules` and always use Verdaccio. This is helpful for ensuring in e.g. End-To-End test environments that the package installation is correct.
+- **Alias:** `-f`
 
-## `--verbose`
+- **Commands:** `secco`, `secco packages`
 
-Output additional debug logs and more information.
+Disable the copying of files into `node_modules` and always use Verdaccio. This is helpful for ensuring in e.g. End-To-End test environments that the package installation is correct.

integration/__tests__/commands.ts

@@ -0,0 +1,12 @@
+import { SeccoCLI } from '../../helpers/invoke-cli'
+
+describe('--help', () => {
+  it('should display usage overview', () => {
+    const [exitCode, logs] = SeccoCLI().invoke(['--help'])
+
+    logs.should.contain('Usage:')
+    logs.should.contain('Options:')
+    logs.should.contain('Examples:')
+    expect(exitCode).toBe(0)
+  })
+})

integration/__tests__/commands/help.ts

@@ -0,0 +1,49 @@
+import path from 'node:path'
+import { fileExists } from 'verdaccio/build/lib/utils'
+import { createTempDir, fileContainsText } from '../../helpers/files'
+import { SeccoCLI } from '../../helpers/invoke-cli'
+
+const initQuestion = 'What is the absolute path to your source?'
+const warning = '.seccorc file already exists in this directory'
+
+describe('init', () => {
+  it('should work in directory without .seccorc file', () => {
+    const [exitCode, logs] = SeccoCLI().setFixture('empty').invoke(['init'])
+
+    logs.should.contain(initQuestion)
+    logs.should.not.contain(warning)
+    expect(exitCode).toBe(0)
+  })
+  it('should warn in directory with .seccorc file', () => {
+    const [exitCode, logs] = SeccoCLI().setFixture('existing-config-file').invoke(['init'])
+
+    logs.should.contain(initQuestion)
+    logs.should.contain(warning)
+    expect(exitCode).toBe(0)
+  })
+  it('should create config file after providing valid input', async () => {
+    const [testDir, cleanup] = await createTempDir('init-command')
+    const input = '/some/absolute/path/to/source'
+
+    try {
+      const [exitCode, logs] = SeccoCLI().setEnv({ TEST: undefined, VITEST: undefined, VITEST_MODE: undefined, VITEST_WORKER_ID: undefined, VITEST_POOL_ID: undefined }).setCwd(testDir).invoke(['init', '--source', input, '--yes'])
+
+      logs.should.contain('Successfully created .seccorc')
+      expect(exitCode).toBe(0)
+
+      const file = await fileExists(path.join(testDir, '.seccorc'))
+      expect(file).toBe(true)
+      const contents = await fileContainsText(path.join(testDir, '.seccorc'), input)
+      expect(contents).toBe(true)
+    }
+    finally {
+      await cleanup()
+    }
+  })
+  it('should error on invalid input', () => {
+    const [exitCode, logs] = SeccoCLI().setFixture('empty').invoke(['init', '--source', 'relative-path', '--yes'])
+
+    logs.should.contain('You need to provide an absolute path for the --source flag.')
+    expect(exitCode).toBe(1)
+  })
+})

integration/__tests__/commands/init.ts

@@ -0,0 +1,2 @@
+describe.todo('packages', () => {
+})