@toptal/davinci-code 2.0.8-alpha-CRT-5891-create-coverage-command-3e3ae146.46 → 2.0.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 2.0.8
+
+### Patch Changes
+
+- [#2021](https://github.com/toptal/davinci/pull/2021) [`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc) Thanks [@dmaklygin](https://github.com/dmaklygin)!
+
+---
+
+- standardize command syntax for consistency
+- Updated dependencies [[`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc)]:
+  - @toptal/davinci-cli-shared@2.3.1
+
 ## 2.0.7
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-code",
-  "version": "2.0.8-alpha-CRT-5891-create-coverage-command-3e3ae146.46+3e3ae146",
+  "version": "2.0.8",
   "description": "Code generation package for frontend applications",
   "publishConfig": {
     "access": "public"
@@ -16,6 +16,9 @@
   "bin": {
     "davinci-code": "./bin/davinci-code.mjs"
   },
+  "scripts": {
+    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' yarn jest"
+  },
   "main": "src/index.mjs",
   "files": [
     "src",
@@ -32,10 +35,12 @@
     "url": "https://github.com/toptal/davinci/issues"
   },
   "dependencies": {
-    "@toptal/davinci-cli-shared": "2.3.1-alpha-CRT-5891-create-coverage-command-3e3ae146.46+3e3ae146",
+    "@toptal/davinci-cli-shared": "2.3.1",
     "hygen": "^6.2.11",
     "lodash.camelcase": "^4.3.0",
     "lodash.kebabcase": "^4.1.1"
   },
-  "gitHead": "3e3ae146eca363a09b91658e20d7295f9934b977"
+  "devDependencies": {
+    "@jest/globals": "^29.4.2"
+  }
 }

package/src/commands/__snapshots__/component.test.mjs.snap

@@ -0,0 +1,67 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createNewCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 0,
+  "commands": [],
+  "options": [],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [
+    {
+      "description": "Name of template: component, page etc.",
+      "variadic": false,
+      "required": true,
+      "_name": "templateName"
+    },
+    {
+      "description": "Name of a folder",
+      "variadic": false,
+      "required": true,
+      "_name": "name"
+    },
+    {
+      "description": "Module where a new folder will be created",
+      "variadic": false,
+      "defaultValue": "core",
+      "required": false,
+      "_name": "moduleName"
+    }
+  ],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "new",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Generate a component",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
+`;

package/src/commands/__snapshots__/module.test.mjs.snap

@@ -0,0 +1,55 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createModuleCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 0,
+  "commands": [],
+  "options": [],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [
+    {
+      "description": "Module name",
+      "variadic": false,
+      "defaultValue": "core",
+      "required": false,
+      "_name": "name"
+    }
+  ],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "module",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Generate a module",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
+`;

package/src/commands/__snapshots__/stories.test.mjs.snap

@@ -0,0 +1,54 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createStoriesCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 0,
+  "commands": [],
+  "options": [],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [
+    {
+      "description": "Pathname to component directory",
+      "variadic": false,
+      "required": true,
+      "_name": "componentDirectory"
+    }
+  ],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "stories",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Generate Storybook stories for the component",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
+`;

package/src/commands/component.mjs

@@ -1,37 +1,21 @@
 import kebabCase from 'lodash.kebabcase'
 import camelCase from 'lodash.camelcase'
 import { print, createArgument } from '@toptal/davinci-cli-shared'
-
 import templates from '../templates.mjs'
 import { CORE_MODULE } from '../constants.mjs'
-
-const componentCommandCreator = {
-  command: 'new',
-  isDefault: true,
-  args: [
-    createArgument('<templateName>', 'Name of template: component, page etc.'),
-    createArgument('<name>', 'Name of a folder'),
-    createArgument('[moduleName]', 'Module where a new folder will be created').default(CORE_MODULE)
-  ],
-  description: 'Generate a component',
-  action: (templateName, name, moduleName) => {
+export const createNewCommand = (program) => {
+  return program
+  .createCommand("new", { isDefault: true })
+  .description('Generate a component')
+  .action((templateName, name, moduleName) => {
     const componentName = camelCase(name)
     const componentModuleName = kebabCase(moduleName)
     const template = camelCase(templateName)
-
-    print.header(
-      'Creating new',
-      componentName,
-      'in the module',
-      componentModuleName,
-      'with template',
-      template
-    )
-
+    print.header('Creating new', componentName, 'in the module', componentModuleName, 'with template', template)
     templates.generate(template, componentName, componentModuleName)
-
     print.success('Done!')
-  },
+  })
+  .addArgument(createArgument('<templateName>', 'Name of template: component, page etc.'))
+  .addArgument(createArgument('<name>', 'Name of a folder'))
+  .addArgument(createArgument('[moduleName]', 'Module where a new folder will be created').default(CORE_MODULE))
 }
-
-export default componentCommandCreator

package/src/commands/component.test.mjs

@@ -0,0 +1,24 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
+
+const { createNewCommand } = await import('./component.mjs')
+
+describe('createNewCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('creates a command with the correct parameters', () => {
+    const command = createNewCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
+  })
+})

package/src/commands/module.mjs

@@ -1,24 +1,16 @@
-import kebabCase from 'lodash.kebabcase'
-import { print } from '@toptal/davinci-cli-shared'
-
-import templates from '../templates.mjs'
-import { CORE_MODULE } from '../constants.mjs'
-
-const moduleCommandCreator = {
-  command: 'module',
-  description: 'Generate a module',
-  args: [
-    ['[name]', 'Module name', CORE_MODULE]
-  ],
-  action: (name) => {
-    const moduleName = kebabCase(name)
-
-    print.header('Creating new module:', moduleName)
-
-    templates.generateModule(moduleName)
-
-    print.success('Done!')
-  },
+import kebabCase from 'lodash.kebabcase';
+import { print, createArgument } from '@toptal/davinci-cli-shared';
+import templates from '../templates.mjs';
+import { CORE_MODULE } from '../constants.mjs';
+export const createModuleCommand = (program) => {
+  return program
+  .createCommand("module")
+  .description('Generate a module')
+  .action(name => {
+    const moduleName = kebabCase(name);
+    print.header('Creating new module:', moduleName);
+    templates.generateModule(moduleName);
+    print.success('Done!');
+  })
+  .addArgument(createArgument('[name]', 'Module name').default(CORE_MODULE))
 }
-
-export default moduleCommandCreator

package/src/commands/module.test.mjs

@@ -0,0 +1,24 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
+
+const { createModuleCommand } = await import('./module.mjs')
+
+describe('createModuleCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('creates a command with the correct parameters', () => {
+    const command = createModuleCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
+  })
+})

package/src/commands/stories.mjs

@@ -1,18 +1,13 @@
 import { print } from '@toptal/davinci-cli-shared'
 import fs from 'fs/promises'
-
 import templates from '../templates.mjs'
-
-const storiesCommandCreator = {
-  command: 'stories',
-  description: 'Generate Storybook stories for the component',
-  args: [
-    ['<componentDirectory>', 'Pathname to component directory']
-  ],
-  action: async (componentDirectory) => {
+export function createStoriesCommand(program) {
+  return program
+  .createCommand("stories")
+  .description('Generate Storybook stories for the component')
+  .action(async componentDirectory => {
     try {
       const fileStat = await fs.stat(componentDirectory)
-
       if (!fileStat.isDirectory()) {
         throw Error('path is not a directory')
       }
@@ -20,16 +15,9 @@ const storiesCommandCreator = {
       print.red(`Path ${componentDirectory} is not a valid component directory`)
       throw e
     }
-
-    print.header(
-      'Creating new stories file for component at:',
-      componentDirectory
-    )
-
+    print.header('Creating new stories file for component at:', componentDirectory)
     templates.generate('stories', componentDirectory)
-
     print.success('Done!')
-  },
+  })
+  .argument('<componentDirectory>', 'Pathname to component directory')
 }
-
-export default storiesCommandCreator

package/src/commands/stories.test.mjs

@@ -0,0 +1,24 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { jest } from '@jest/globals'
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { Command } from 'commander'
+
+const { createStoriesCommand } = await import('./stories.mjs')
+
+describe('createStoriesCommand', () => {
+  let program
+
+  beforeEach(() => {
+    program = new Command()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('creates a command with the correct parameters', () => {
+    const command = createStoriesCommand(program)
+
+    expect(JSON.stringify(command, null, 2)).toMatchSnapshot()
+  })
+})

package/src/index.mjs

@@ -1,13 +1,13 @@
-import moduleCommandCreator from './commands/module.mjs';
-import componentCommandCreator from './commands/component.mjs';
-import storiesCommandCreator from './commands/stories.mjs';
+import { createModuleCommand } from './commands/module.mjs'
+import { createNewCommand } from './commands/component.mjs'
+import { createStoriesCommand} from './commands/stories.mjs'
 
 export const commands = [
-  moduleCommandCreator,
-  storiesCommandCreator,
-  componentCommandCreator,
+  createModuleCommand,
+  createStoriesCommand,
+  createNewCommand,
 ]
 
 export default {
   commands
-};
+}