oneclickpush 0.3.0 → 0.4.1

package/README.md

@@ -109,7 +109,7 @@ const changes = await deploy({
   author: 'Deploy Bot <bot@example.com>',
   force: false,
   dryRun: false,
-  logLevel: 'normal'
+  verbose: false
 })
 
 if (changes) {
@@ -119,31 +119,19 @@ if (changes) {
 }
 ```
 
-The default values are also exported as `DEFAULTS`:
-
-```javascript
-import { DEFAULTS } from 'oneclickpush'
-
-console.log(DEFAULTS.branch) // "gh-pages"
-```
-
 ### Options
 
-| Option     | Type                                | Default            | Description                                         |
-| ---------- | ----------------------------------- | ------------------ | --------------------------------------------------- |
-| `dir`      | `string`                            | - (required)       | Directory to deploy                                 |
-| `exclude`  | `string[]`                          | `["**/.DS_Store"]` | Paths to exclude relative to `dir`                  |
-| `branch`   | `string`                            | `"gh-pages"`       | Target git branch                                   |
-| `message`  | `string`                            | `"Updates"`        | Git commit message                                  |
-| `remote`   | `string`                            | `"origin"`         | Remote name or repository URL/path to deploy to     |
-| `author`   | `string`                            | -                  | Commit author and committer, as `"Name <email>"`    |
-| `force`    | `boolean`                           | `false`            | Force push fresh commit with no previous history    |
-| `dryRun`   | `boolean`                           | `false`            | Return staged changes without committing or pushing |
-| `logLevel` | `"silent" \| "normal" \| "verbose"` | `"normal"`         | Only `"verbose"` has an effect: logs git commands   |
-
-> [!NOTE]  
-> The library never prints anything except at `"verbose"`. `"silent"` and `"normal"` only differ in
-> the CLI.
+| Name      | Type       | Default            | Description                                         |
+| --------- | ---------- | ------------------ | --------------------------------------------------- |
+| `dir`     | `string`   | - (required)       | Directory to deploy                                 |
+| `exclude` | `string[]` | `["**/.DS_Store"]` | Paths to exclude relative to `dir`                  |
+| `branch`  | `string`   | `"gh-pages"`       | Target git branch                                   |
+| `message` | `string`   | `"Updates"`        | Git commit message                                  |
+| `remote`  | `string`   | `"origin"`         | Remote name or repository URL/path to deploy to     |
+| `author`  | `string`   | -                  | Commit author and committer, as `"Name <email>"`    |
+| `force`   | `boolean`  | `false`            | Force push fresh commit with no previous history    |
+| `dryRun`  | `boolean`  | `false`            | Return staged changes without committing or pushing |
+| `verbose` | `boolean`  | `false`            | Logs git commands to stderr                         |
 
 ## How It Works
 

package/cli.js

@@ -1,7 +1,17 @@
 #!/usr/bin/env node
 import { parseArgs } from 'node:util'
 import { readFileSync } from 'node:fs'
-import { deploy, DEFAULTS } from './index.js'
+import { deploy } from './index.js'
+
+const DEFAULTS = {
+  exclude: ['**/.DS_Store'],
+  branch: 'gh-pages',
+  message: 'Updates',
+  remote: 'origin',
+  force: false,
+  dryRun: false,
+  logLevel: 'normal'
+}
 
 const HELP = `Usage: oneclickpush <dir> [options]
 
@@ -37,6 +47,12 @@ commands and full errors.`
 
 const LEVELS = ['silent', 'normal', 'verbose']
 
+/** @param {string} msg @returns {never} */
+const fail = (msg) => {
+  console.error(`${msg}\nTry "oneclickpush --help" for usage`)
+  process.exit(1)
+}
+
 const { values: v, positionals } = (() => {
   try {
     return parseArgs({
@@ -57,9 +73,7 @@ const { values: v, positionals } = (() => {
   } catch (/** @type {any} */ e) {
     if (!e.code?.startsWith('ERR_PARSE_ARGS_')) throw e
     // Keep only the first sentence, Node appends a long "-- " hint to some messages
-    const msg = e.message.split('. ')[0].replace(/\.$/, '')
-    console.error(`${msg}, run "oneclickpush --help" for usage`)
-    process.exit(1)
+    fail(e.message.split('. ')[0].replace(/\.$/, ''))
   }
 })()
 
@@ -75,19 +89,15 @@ if (v.version) {
 }
 
 if (positionals.length !== 1) {
-  console.error(
-    positionals.length === 0
-      ? 'Missing required argument <dir>, run "oneclickpush --help" for usage'
-      : 'Expected exactly one directory, run "oneclickpush --help" for usage'
+  fail(
+    positionals.length === 0 ? 'Missing required argument <dir>' : 'Expected exactly one directory'
   )
-  process.exit(1)
 }
 const dir = positionals[0]
 
-const level = /** @type {import('./index.js').OcpOptionsLogLevel} */ (v['log-level'])
+const level = v['log-level']
 if (!LEVELS.includes(level)) {
-  console.error(`Invalid --log-level "${level}", expected one of: ${LEVELS.join(', ')}`)
-  process.exit(1)
+  fail(`Invalid --log-level "${level}", expected one of: ${LEVELS.join(', ')}`)
 }
 
 // Dead simple spinner (normal level, TTY only)
@@ -100,7 +110,7 @@ const spin =
 const stop = () => spin && (clearInterval(spin), process.stderr.write('\r \r'))
 
 try {
-  const changes = await deploy({ ...v, dir, logLevel: level, dryRun: v['dry-run'] })
+  const changes = await deploy({ ...v, dir, verbose: level === 'verbose', dryRun: v['dry-run'] })
   stop()
   if (level !== 'silent') {
     console.log(

package/index.d.ts

@@ -1,68 +1,16 @@
-export type OcpOptionsLogLevel = 'silent' | 'normal' | 'verbose'
-/** @typedef {'silent' | 'normal' | 'verbose'} OcpOptionsLogLevel */
-export declare const DEFAULTS: {
-  exclude: string[]
-  branch: string
-  message: string
-  remote: string
-  force: boolean
-  dryRun: boolean
-  logLevel: OcpOptionsLogLevel
-}
-export type OcpOptions = {
-  /**
-   * Directory to deploy (required)
-   */
-  dir: string
-  /**
-   * Paths to leave out, relative to dir (default: `**\/.DS_Store`)
-   */
-  exclude?: string[]
-  /**
-   * Target branch
-   */
-  branch?: string
-  /**
-   * Commit message
-   */
-  message?: string
-  /**
-   * Remote name of the current repo, or a repository URL or path
-   */
-  remote?: string
-  /**
-   * Commit author and committer as "Name <email>"
-   */
-  author?: string
-  /**
-   * Force push new commit with no history
-   */
-  force?: boolean
-  /**
-   * Show what would change, without committing or pushing
-   */
-  dryRun?: boolean
-  /**
-   * Only "verbose" logs (git commands, to stderr)
-   */
-  logLevel?: OcpOptionsLogLevel
-}
-/**
- * @typedef {object} OcpOptions
- * @prop {string} dir Directory to deploy (required)
- * @prop {string[]} [exclude] Paths to leave out, relative to dir (default: `**\/.DS_Store`)
- * @prop {string} [branch="gh-pages"] Target branch
- * @prop {string} [message="Updates"] Commit message
- * @prop {string} [remote="origin"] Remote name of the current repo, or a repository URL or path
- * @prop {string} [author] Commit author and committer as "Name <email>"
- * @prop {boolean} [force=false] Force push new commit with no history
- * @prop {boolean} [dryRun=false] Show what would change, without committing or pushing
- * @prop {OcpOptionsLogLevel} [logLevel="normal"] Only "verbose" logs (git commands, to stderr)
- */
 /**
  * Replace the contents of a git branch with the contents of a directory.
  * Returns the staged changes as `git diff --name-status` text or "" if nothing changed.
- * @param {OcpOptions} options
+ * @param {object} o
+ * @param {string} o.dir Directory to deploy (required)
+ * @param {string[]} [o.exclude] Paths to leave out, relative to dir (default: `**\/.DS_Store`)
+ * @param {string} [o.branch="gh-pages"] Target branch
+ * @param {string} [o.message="Updates"] Commit message
+ * @param {string} [o.remote="origin"] Remote name of the current repo, or a repository URL or path
+ * @param {string} [o.author] Commit author and committer as "Name <email>"
+ * @param {boolean} [o.force=false] Force push new commit with no history
+ * @param {boolean} [o.dryRun=false] Return staged changes without committing or pushing
+ * @param {boolean} [o.verbose=false] Log git commands to stderr
  * @returns {Promise<string>}
  */
 export declare function deploy({
@@ -74,5 +22,15 @@ export declare function deploy({
   author,
   force,
   dryRun,
-  logLevel
-}: OcpOptions): Promise<string>
+  verbose
+}: {
+  dir: string
+  exclude?: string[]
+  branch?: string
+  message?: string
+  remote?: string
+  author?: string
+  force?: boolean
+  dryRun?: boolean
+  verbose?: boolean
+}): Promise<string>

package/index.js

@@ -4,47 +4,31 @@ import { mkdtemp, rm } from 'node:fs/promises'
 import { tmpdir } from 'node:os'
 import { join, resolve } from 'node:path'
 
-/** @typedef {'silent' | 'normal' | 'verbose'} OcpOptionsLogLevel */
-
-export const DEFAULTS = {
-  exclude: ['**/.DS_Store'],
-  branch: 'gh-pages',
-  message: 'Updates',
-  remote: 'origin',
-  force: false,
-  dryRun: false,
-  logLevel: /** @type {OcpOptionsLogLevel} */ ('normal')
-}
-
-/**
- * @typedef {object} OcpOptions
- * @prop {string} dir Directory to deploy (required)
- * @prop {string[]} [exclude] Paths to leave out, relative to dir (default: `**\/.DS_Store`)
- * @prop {string} [branch="gh-pages"] Target branch
- * @prop {string} [message="Updates"] Commit message
- * @prop {string} [remote="origin"] Remote name of the current repo, or a repository URL or path
- * @prop {string} [author] Commit author and committer as "Name <email>"
- * @prop {boolean} [force=false] Force push new commit with no history
- * @prop {boolean} [dryRun=false] Show what would change, without committing or pushing
- * @prop {OcpOptionsLogLevel} [logLevel="normal"] Only "verbose" logs (git commands, to stderr)
- */
-
 /**
  * Replace the contents of a git branch with the contents of a directory.
  * Returns the staged changes as `git diff --name-status` text or "" if nothing changed.
- * @param {OcpOptions} options
+ * @param {object} o
+ * @param {string} o.dir Directory to deploy (required)
+ * @param {string[]} [o.exclude] Paths to leave out, relative to dir (default: `**\/.DS_Store`)
+ * @param {string} [o.branch="gh-pages"] Target branch
+ * @param {string} [o.message="Updates"] Commit message
+ * @param {string} [o.remote="origin"] Remote name of the current repo, or a repository URL or path
+ * @param {string} [o.author] Commit author and committer as "Name <email>"
+ * @param {boolean} [o.force=false] Force push new commit with no history
+ * @param {boolean} [o.dryRun=false] Return staged changes without committing or pushing
+ * @param {boolean} [o.verbose=false] Log git commands to stderr
  * @returns {Promise<string>}
  */
 export async function deploy({
   dir,
-  exclude = DEFAULTS.exclude,
-  branch = DEFAULTS.branch,
-  message = DEFAULTS.message,
-  remote = DEFAULTS.remote,
+  exclude = ['**/.DS_Store'],
+  branch = 'gh-pages',
+  message = 'Updates',
+  remote = 'origin',
   author,
-  force = DEFAULTS.force,
-  dryRun = DEFAULTS.dryRun,
-  logLevel = DEFAULTS.logLevel
+  force = false,
+  dryRun = false,
+  verbose = false
 }) {
   if (!dir) throw new Error('dir is required')
   dir = resolve(dir)
@@ -66,7 +50,7 @@ export async function deploy({
 
   /** @type {(args: string[], cwd?: string, env?: Record<string, string>) => Promise<string>} */
   const git = async (args, cwd, env) => {
-    if (logLevel === 'verbose') console.error(`$ git ${args.join(' ')}`)
+    if (verbose) console.error(`$ git ${args.join(' ')}`)
     const { stdout } = await run('git', args, { cwd, env: { ...process.env, ...env } })
     return stdout.trim()
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneclickpush",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "One-click GitHub Pages deployer",
   "author": "Jason Lee <jason@zerodevx.com>",
   "scripts": {
@@ -11,7 +11,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "eslint": "^10.12.0",
+    "eslint": "^10.13.0",
     "globals": "^17.13.0",
     "prettier": "^3.9.10",
     "typescript": "^7.0.2"