✨ Ask for package manager when is JS project

src/project-infos.js

@@ -7,7 +7,8 @@ const { execSync } = require('child_process')
 const {
   getPackageJson,
   getProjectName,
-  getAuthorWebsiteFromGithubAPI
+  getAuthorWebsiteFromGithubAPI,
+  getPackageManagerFromLockFile
 } = require('./utils')
 
 const GITHUB_URL = 'https://github.com/'
@@ -128,17 +129,18 @@ const getProjectInfos = async () => {
 
   const packageJson = await getPackageJson()
   const isJSProject = !!packageJson
+  const packageManager = isJSProject
+    ? getPackageManagerFromLockFile()
+    : undefined
   const name = getProjectName(packageJson)
   const description = get(packageJson, 'description', undefined)
   const engines = get(packageJson, 'engines', undefined)
   const author = getAuthorName(packageJson)
   const version = get(packageJson, 'version', undefined)
   const licenseName = get(packageJson, 'license', undefined)
   const homepage = get(packageJson, 'homepage', undefined)
-  const usage = has(packageJson, 'scripts.start') ? 'npm run start' : undefined
-  const testCommand = has(packageJson, 'scripts.test')
-    ? 'npm run test'
-    : undefined
+  const hasStartCommand = has(packageJson, 'scripts.start')
+  const hasTestCommand = has(packageJson, 'scripts.test')
   const repositoryUrl = await getReposUrl(packageJson)
   const issuesUrl = await getReposIssuesUrl(packageJson)
   const isGithubRepos = isGithubRepository(repositoryUrl)
@@ -176,9 +178,10 @@ const getProjectInfos = async () => {
     licenseUrl,
     documentationUrl,
     isGithubRepos,
-    usage,
-    testCommand,
-    isJSProject
+    hasStartCommand,
+    hasTestCommand,
+    isJSProject,
+    packageManager
   }
 }
 

src/project-infos.spec.js

@@ -11,7 +11,10 @@ jest.mock('child_process', () => ({
 jest.mock('./utils', () => ({
   getPackageJson: jest.fn(),
   getProjectName: jest.fn(() => 'readme-md-generator'),
-  getAuthorWebsiteFromGithubAPI: jest.fn(() => 'https://www.franck-abgrall.me/')
+  getAuthorWebsiteFromGithubAPI: jest.fn(
+    () => 'https://www.franck-abgrall.me/'
+  ),
+  getPackageManagerFromLockFile: jest.fn(() => 'yarn')
 }))
 
 const succeed = jest.fn()
@@ -85,8 +88,9 @@ describe('projectInfos', () => {
         isGithubRepos: true,
         isJSProject: true,
         issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
-        usage: undefined,
-        testCommand: undefined
+        hasStartCommand: false,
+        hasTestCommand: false,
+        packageManager: 'yarn'
       })
     })
 
@@ -138,8 +142,9 @@ describe('projectInfos', () => {
         isGithubRepos: false,
         isJSProject: true,
         issuesUrl: 'https://gitlab.com/kefranabg/readme-md-generator/issues',
-        usage: undefined,
-        testCommand: undefined
+        hasStartCommand: false,
+        hasTestCommand: false,
+        packageManager: 'yarn'
       })
     })
 
@@ -171,8 +176,8 @@ describe('projectInfos', () => {
         isGithubRepos: true,
         isJSProject: false,
         issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
-        usage: undefined,
-        testCommand: undefined
+        hasStartCommand: false,
+        hasTestCommand: false
       })
     })
 
@@ -202,8 +207,8 @@ describe('projectInfos', () => {
         isGithubRepos: false,
         isJSProject: false,
         issuesUrl: 'https://gitlab.com/kefranabg/readme-md-generator/issues',
-        usage: undefined,
-        testCommand: undefined
+        hasStartCommand: false,
+        hasTestCommand: false
       })
     })
 
@@ -231,8 +236,9 @@ describe('projectInfos', () => {
         documentationUrl: undefined,
         isGithubRepos: false,
         isJSProject: false,
-        usage: undefined,
-        testCommand: undefined
+        testCommand: undefined,
+        hasStartCommand: false,
+        hasTestCommand: false
       })
     })
 
@@ -286,8 +292,9 @@ describe('projectInfos', () => {
         isGithubRepos: true,
         isJSProject: true,
         issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
-        usage: undefined,
-        testCommand: undefined
+        hasStartCommand: false,
+        hasTestCommand: false,
+        packageManager: 'yarn'
       })
     })
 
@@ -345,8 +352,70 @@ describe('projectInfos', () => {
         isGithubRepos: true,
         isJSProject: true,
         issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
-        usage: undefined,
-        testCommand: undefined
+        hasStartCommand: false,
+        hasTestCommand: false,
+        packageManager: 'yarn'
+      })
+    })
+
+    it('should return correct infos when lock file is found', async () => {
+      const packgeJsonInfos = {
+        name: 'readme-md-generator',
+        version: '0.1.3',
+        description: 'CLI that generates beautiful README.md files.',
+        author: 'Franck Abgrall',
+        license: 'MIT',
+        homepage: 'https://github.com/kefranabg/readme-md-generator',
+        repository: {
+          type: 'git',
+          url: 'git+https://github.com/kefranabg/readme-md-generator.git'
+        },
+        bugs: {
+          url: 'https://github.com/kefranabg/readme-md-generator/issues'
+        },
+        engines: {
+          npm: '>=5.5.0',
+          node: '>=9.3.0'
+        },
+        scripts: {
+          start: 'node src/index.js',
+          test: 'jest'
+        }
+      }
+      utils.getPackageJson.mockReturnValueOnce(Promise.resolve(packgeJsonInfos))
+      utils.getPackageManagerFromLockFile.mockReturnValueOnce('yarn')
+      childProcess.execSync.mockReturnValue(
+        'https://github.com/kefranabg/readme-md-generator.git'
+      )
+
+      const projectInfos = await getProjectInfos()
+
+      expect(projectInfos).toEqual({
+        name: 'readme-md-generator',
+        description: 'CLI that generates beautiful README.md files.',
+        version: '0.1.3',
+        author: 'Franck Abgrall',
+        repositoryUrl: 'https://github.com/kefranabg/readme-md-generator',
+        homepage: 'https://github.com/kefranabg/readme-md-generator',
+        contributingUrl:
+          'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
+        authorWebsite: 'https://www.franck-abgrall.me/',
+        githubUsername: 'kefranabg',
+        engines: {
+          npm: '>=5.5.0',
+          node: '>=9.3.0'
+        },
+        licenseName: 'MIT',
+        licenseUrl:
+          'https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE',
+        documentationUrl:
+          'https://github.com/kefranabg/readme-md-generator#readme',
+        isGithubRepos: true,
+        isJSProject: true,
+        issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
+        hasStartCommand: true,
+        hasTestCommand: true,
+        packageManager: 'yarn'
       })
     })
   })

src/questions/index.js

@@ -3,6 +3,7 @@ module.exports = {
   askProjectName: require('./project-name'),
   askProjectVersion: require('./project-version'),
   askProjectDescription: require('./project-description'),
+  askPackageManager: require('./package-manager'),
   askProjectHomepage: require('./project-homepage'),
   askProjectDemoUrl: require('./project-demo-url'),
   askProjectDocumentationUrl: require('./project-documentation-url'),

src/questions/index.spec.js

@@ -8,6 +8,7 @@ describe('questions', () => {
       'askProjectName',
       'askProjectVersion',
       'askProjectDescription',
+      'askPackageManager',
       'askProjectHomepage',
       'askProjectDemoUrl',
       'askProjectDocumentationUrl',

src/questions/install-command.js

@@ -1,6 +1,11 @@
+const isNil = require('lodash/isNil')
+
 module.exports = projectInfos => ({
   type: 'input',
   message: '📦  Install command (use empty value to skip)',
   name: 'installCommand',
-  default: projectInfos.isJSProject ? 'npm install' : undefined
+  default: answers => {
+    const packageManager = answers.packageManager || projectInfos.packageManager
+    return isNil(packageManager) ? undefined : `${packageManager} install`
+  }
 })

src/questions/install-command.spec.js

@@ -1,27 +1,34 @@
 const askInstallCommand = require('./install-command')
 
 describe('askInstallCommand', () => {
-  it('should return correct question format when project lang is js', () => {
-    const projectInfos = { isJSProject: true }
-    const result = askInstallCommand(projectInfos)
+  it('should return correct question format', () => {
+    const result = askInstallCommand()
+    expect(result).toEqual(
+      expect.objectContaining({
+        type: 'input',
+        message: '📦  Install command (use empty value to skip)',
+        name: 'installCommand'
+      })
+    )
+  })
+
+  it('should return undefined default answer when package manager is not defined', () => {
+    const projectInfos = {}
 
-    expect(result).toEqual({
-      type: 'input',
-      message: '📦  Install command (use empty value to skip)',
-      name: 'installCommand',
-      default: 'npm install'
+    const result = askInstallCommand(projectInfos).default({
+      packageManager: undefined
     })
+
+    expect(result).toBeUndefined()
   })
 
-  it('should return correct question format when project lang is not js', () => {
-    const projectInfos = { isJSProject: false }
-    const result = askInstallCommand(projectInfos)
+  it('should return correct default answer when package manager is defined', () => {
+    const projectInfos = {}
 
-    expect(result).toEqual({
-      type: 'input',
-      message: '📦  Install command (use empty value to skip)',
-      name: 'installCommand',
-      default: undefined
+    const result = askInstallCommand(projectInfos).default({
+      packageManager: 'yarn'
     })
+
+    expect(result).toEqual('yarn install')
   })
 })

src/questions/package-manager.js

@@ -0,0 +1,18 @@
+const isEmpty = require('lodash/isEmpty')
+
+module.exports = projectInfos => ({
+  type: 'list',
+  message: '📦  Choose Package Manager ',
+  name: 'packageManager',
+  choices: [
+    {
+      name: 'npm',
+      value: 'npm'
+    },
+    {
+      name: 'yarn',
+      value: 'yarn'
+    }
+  ],
+  when: () => projectInfos.isJSProject && isEmpty(projectInfos.packageManager)
+})

src/questions/package-manager.spec.js

@@ -0,0 +1,47 @@
+const askPackageManager = require('./package-manager')
+
+const expectedQuestion = {
+  type: 'list',
+  message: '📦  Choose Package Manager ',
+  name: 'packageManager',
+  choices: [
+    {
+      name: 'npm',
+      value: 'npm'
+    },
+    {
+      name: 'yarn',
+      value: 'yarn'
+    }
+  ]
+}
+
+describe('askPackageManager', () => {
+  it('should return correct question format when package manager is undefined', () => {
+    const projectInfos = { packageManager: undefined }
+    const result = askPackageManager(projectInfos)
+
+    expect(result).toEqual(expect.objectContaining(expectedQuestion))
+  })
+
+  it('should not show question for a non JS Project', () => {
+    const projectInfos = { isJSProject: false, packageManager: undefined }
+    const result = askPackageManager(projectInfos).when(projectInfos)
+
+    expect(result).toBe(false)
+  })
+
+  it('should not show question when package manager has already been detected', () => {
+    const projectInfos = { isJSProject: true, packageManager: 'yarn' }
+    const result = askPackageManager(projectInfos).when(projectInfos)
+
+    expect(result).toBe(false)
+  })
+
+  it('should show question when package manager is undefined and if project is JS', () => {
+    const projectInfos = { isJSProject: true, packageManager: undefined }
+    const result = askPackageManager(projectInfos).when(projectInfos)
+
+    expect(result).toBe(true)
+  })
+})

src/questions/test-command.js

@@ -1,6 +1,13 @@
+const isNil = require('lodash/isNil')
+
 module.exports = projectInfos => ({
   type: 'input',
   message: '✅  Test command (use empty value to skip)',
   name: 'testCommand',
-  default: projectInfos.testCommand
+  default: answers => {
+    const packageManager = answers.packageManager || projectInfos.packageManager
+    return projectInfos.hasTestCommand && !isNil(packageManager)
+      ? `${packageManager} run test`
+      : undefined
+  }
 })