@neurodevs/ndx-cli 0.1.55 → 0.1.58

package/src/__tests__/modules/commands/UpgradePackageCommand.test.ts

@@ -0,0 +1,105 @@
+import { test, generateId, assert } from '@sprucelabs/test-utils'
+import { FakeAutopackage } from '@neurodevs/meta-node'
+import AbstractCommandRunnerTest from '../../AbstractCommandRunnerTest'
+
+export default class UpgradePackageCommandTest extends AbstractCommandRunnerTest {
+    protected static async beforeEach() {
+        await super.beforeEach()
+    }
+
+    @test()
+    protected static async createsInstance() {
+        const instance = await this.run()
+
+        assert.isTruthy(
+            instance,
+            `Failed to create instance for ${this.upgradePackageCommand}!`
+        )
+    }
+
+    @test()
+    protected static async createsNpmAutopackage() {
+        await this.run()
+
+        assert.isEqualDeep(
+            FakeAutopackage.callsToConstructor[0],
+            {
+                ...this.infoFromPackageJson,
+                name: `${this.packageName}`,
+                gitNamespace: 'neurodevs',
+                npmNamespace: 'neurodevs',
+                installDir: this.expandHomeDir('~/dev'),
+                license: 'MIT',
+                author: 'Eric Yates <hello@ericthecurious.com>',
+            },
+            'Did not create NpmAutopackage with expected options!'
+        )
+    }
+
+    @test()
+    protected static async runsNpmAutopackage() {
+        await this.run()
+
+        assert.isEqual(
+            FakeAutopackage.numCallsToRun,
+            1,
+            'Did not call run on NpmAutopackage!'
+        )
+    }
+
+    @test()
+    protected static async addsDefaultKeywordsIfMissing() {
+        await this.run({
+            name: this.packageName,
+            description: this.description,
+            keywords: [] as string[],
+        })
+
+        assert.isEqualDeep(
+            FakeAutopackage.callsToConstructor[0]?.keywords,
+            this.defaultKeywords,
+            'Did not add default keywords!'
+        )
+    }
+
+    @test()
+    protected static async doesNotOverwriteKeywordsEvenIfDefaultsMissing() {
+        const keywords = [generateId(), generateId()]
+
+        await this.run({
+            name: this.packageName,
+            description: this.description,
+            keywords,
+        })
+
+        assert.isEqualDeep(
+            FakeAutopackage.callsToConstructor[0]?.keywords,
+            [...this.defaultKeywords, ...keywords],
+            'Should not have overwritten keywords!'
+        )
+    }
+
+    @test()
+    protected static async extractsPackageNameFromScopedName() {
+        await this.run({
+            name: this.packageName,
+            description: this.description,
+            keywords: this.keywordsWithDefaults,
+        })
+
+        assert.isEqualDeep(
+            FakeAutopackage.callsToConstructor[0]?.name,
+            this.packageName,
+            'Did not extract package name from scoped name!'
+        )
+    }
+
+    private static async run(responses?: Record<string, string | string[]>) {
+        this.setFakePackageJson(responses)
+
+        const instance = this.CliCommandRunner([this.upgradePackageCommand])
+        await instance.run()
+
+        return instance
+    }
+}

package/src/modules/CliCommandRunner.ts

@@ -2,6 +2,7 @@ import { exec as execSync } from 'child_process'
 import { mkdir, readFile, writeFile } from 'fs/promises'
 import { promisify } from 'util'
 import prompts from 'prompts'
+import BindSnippetCommand from './commands/BindSnippetCommand'
 import CreateImplCommand from './commands/CreateImplCommand'
 import CreatePackageCommand from './commands/CreatePackageCommand'
 import CreateUiCommand from './commands/CreateUiCommand'
@@ -18,21 +19,23 @@ export default class CliCommandRunner implements CommandRunner {
 
     private args: string[]
 
+    private readonly bindSnippetCommand = 'bind.snippet'
     private readonly createImplCommand = 'create.impl'
     private readonly createPackageCommand = 'create.package'
     private readonly createUiCommand = 'create.ui'
     private readonly helpCommand = 'help'
-    private readonly dashDashHelpCommand = '--help'
-    private readonly dashHCommand = '-h'
+    private readonly helpFlagShort = '-h'
+    private readonly helpFlagLong = '--help'
     private readonly upgradePackageCommand = 'upgrade.package'
 
     private readonly supportedCommands = [
+        this.bindSnippetCommand,
         this.createImplCommand,
         this.createPackageCommand,
         this.createUiCommand,
         this.helpCommand,
-        this.dashDashHelpCommand,
-        this.dashHCommand,
+        this.helpFlagShort,
+        this.helpFlagLong,
         this.upgradePackageCommand,
     ]
 
@@ -65,6 +68,9 @@ export default class CliCommandRunner implements CommandRunner {
 
     private async runCommand() {
         switch (this.command) {
+            case this.bindSnippetCommand:
+                await this.bindSnippet()
+                break
             case this.createImplCommand:
                 await this.createImplModule()
                 break
@@ -77,10 +83,10 @@ export default class CliCommandRunner implements CommandRunner {
             case this.helpCommand:
                 await this.help()
                 break
-            case this.dashDashHelpCommand:
+            case this.helpFlagLong:
                 await this.help()
                 break
-            case this.dashHCommand:
+            case this.helpFlagShort:
                 await this.help()
                 break
             case this.upgradePackageCommand:
@@ -89,6 +95,11 @@ export default class CliCommandRunner implements CommandRunner {
         }
     }
 
+    private async bindSnippet() {
+        const command = new BindSnippetCommand()
+        await command.run()
+    }
+
     private async createImplModule() {
         const command = new CreateImplCommand()
         await command.run()
@@ -121,6 +132,7 @@ export default class CliCommandRunner implements CommandRunner {
 
     Available commands:
 
+    - bind.snippet      Bind a text snippet to a keyboard shortcut in vscode.
     - create.impl       Create implementation for interface with test and fake.
     - create.package    Create npm package using latest template.
     - create.ui         Create React component with test and fake.
@@ -129,7 +141,7 @@ export default class CliCommandRunner implements CommandRunner {
     
     Usage:
 
-    - ndx <command> [options]
+    - ndx <command>
     `
 }
 

package/src/modules/commands/BindSnippetCommand.ts

@@ -0,0 +1,75 @@
+import { VscodeSnippetKeybinder } from '@neurodevs/meta-node'
+import CliCommandRunner from '../CliCommandRunner'
+
+export default class BindSnippetCommand {
+    private name!: string
+    private description!: string
+    private lines!: string
+    private keybinding!: string
+
+    public constructor() {}
+
+    public async run() {
+        const { name, description, lines, keybinding } =
+            await this.promptUserForInput()
+
+        this.name = name
+        this.description = description
+        this.lines = lines
+        this.keybinding = keybinding
+
+        if (!this.hasAllUserInput) {
+            return
+        }
+
+        const keybinder = this.VscodeSnippetKeybinder()
+        await keybinder.run()
+    }
+
+    private async promptUserForInput() {
+        return await this.prompts([
+            {
+                type: 'text',
+                name: 'name',
+                message: this.nameMessage,
+            },
+            {
+                type: 'text',
+                name: 'description',
+                message: this.descriptionMessage,
+            },
+            {
+                type: 'text',
+                name: 'lines',
+                message: this.snippetMessage,
+            },
+            {
+                type: 'text',
+                name: 'keybinding',
+                message: this.keybindingMessage,
+            },
+        ])
+    }
+
+    private get hasAllUserInput() {
+        return this.name && this.description && this.lines && this.keybinding
+    }
+
+    private readonly nameMessage = `Snippet name? Example: Singleton class template`
+    private readonly descriptionMessage = `Snippet description? Example: A class template based on the singleton pattern`
+    private readonly snippetMessage = `Snippet text content? Use \\n for newlines. Example: line-1\\nline-2`
+    private readonly keybindingMessage = `Snippet keybinding? Examples: ctrl+alt+c, f4`
+
+    private get prompts() {
+        return CliCommandRunner.prompts
+    }
+
+    private VscodeSnippetKeybinder() {
+        return VscodeSnippetKeybinder.Create({
+            name: this.name,
+            description: this.description,
+            lines: this.lines.split('\\n'),
+            keybinding: this.keybinding,
+        })
+    }
+}

package/src/scripts/runCommandRunner.ts

@@ -1,7 +1,7 @@
 import CliCommandRunner from '../modules/CliCommandRunner'
 
 async function main() {
-    const runner = CliCommandRunner.Create(['create.ui'])
+    const runner = CliCommandRunner.Create(['bind.snippet'])
     await runner.run()
 }