@jcoreio/toolchain 4.0.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcoreio/toolchain",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "base JS build toolchain",
   "repository": {
     "type": "git",

package/scripts/create.cjs

@@ -0,0 +1,200 @@
+const path = require('path')
+const execa = require('../util/execa.cjs')
+const ChdirFs = require('../util/ChdirFs.cjs')
+const pkgName = require('../package.json').name
+const dedent = require('dedent-js')
+
+async function create(args = []) {
+  const prompt = require('prompts')
+
+  const required = (s) => Boolean(s) || 'required'
+
+  let defaultAuthor
+  try {
+    defaultAuthor = (
+      await execa('git', ['config', 'user.name'], {
+        stdio: 'pipe',
+        maxBuffer: 1024,
+        encoding: 'utf8',
+      })
+    ).stdout.trim()
+  } catch (error) {
+    // ignore
+  }
+
+  const questions = [
+    {
+      type: 'text',
+      name: 'directory',
+      message: 'Destination directory:',
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'name',
+      message: 'Package name:',
+      initial: (prev, { directory }) => path.basename(directory),
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'description',
+      message: 'Package description:',
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'author',
+      initial: defaultAuthor,
+      message: 'Package author:',
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'keywords',
+      message: 'Package keywords:',
+      format: (text) => text.split(/\s*,\s*|\s+/g),
+    },
+    {
+      type: 'text',
+      name: 'organization',
+      initial: (prev, { name }) => {
+        const match = /^@(.*?)\//.exec(name)
+        if (match) return match[1]
+      },
+      message: 'GitHub organization:',
+      validate: required,
+    },
+    {
+      type: 'text',
+      name: 'repo',
+      message: 'GitHub repo:',
+      initial: (prev, { name }) => name.replace(/^@(.*?)\//, ''),
+      validate: required,
+    },
+    {
+      type: 'select',
+      name: 'license',
+      message: 'License',
+      choices: Object.entries(licenses).map(([value, { title }]) => ({
+        title,
+        value,
+      })),
+    },
+    {
+      type: 'text',
+      name: 'copyrightHolder',
+      message: 'Copyright holder:',
+      initial: (prev, { author }) => author,
+      validate: required,
+    },
+    {
+      name: 'ready',
+      type: 'confirm',
+      initial: true,
+      message: 'Ready to go?',
+    },
+  ]
+
+  let answers
+  do {
+    answers = await prompt(questions)
+    for (const question of questions) {
+      const { name, transformer } = question
+      if (name !== 'ready') {
+        const answer = answers[name]
+        question.initial = transformer ? transformer(answer) : answer
+      }
+    }
+  } while (!answers.ready)
+
+  const {
+    directory,
+    name,
+    description,
+    author,
+    keywords,
+    license,
+    copyrightHolder,
+    organization,
+    repo,
+  } = answers
+
+  const cwd = path.resolve(directory)
+
+  await require('fs-extra').mkdirs(path.join(cwd, 'src'))
+
+  const fs = ChdirFs(cwd)
+
+  const packageJson = {
+    name,
+    description,
+    repository: {
+      type: 'git',
+      url: `https://github.com/${organization}/${repo}.git`,
+    },
+    homepage: `https://github.com/${organization}/${repo}`,
+    bugs: {
+      url: `https://github.com/${organization}/${repo}`,
+    },
+    author,
+    license,
+    keywords,
+  }
+
+  await fs.writeJson('package.json', packageJson, { spaces: 2 })
+
+  const files = {
+    'README.md': dedent`
+      # ${name}
+
+      ${description}
+
+      [![CircleCI](https://circleci.com/gh/${organization}/${repo}.svg?style=svg)](https://circleci.com/gh/${organization}/${repo})
+      [![Coverage Status](https://codecov.io/gh/${organization}/${repo}/branch/master/graph/badge.svg)](https://codecov.io/gh/${organization}/${repo})
+      [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+      [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+      [![npm version](https://badge.fury.io/js/${encodeURIComponent(
+        name
+      )}.svg)](https://badge.fury.io/js/${encodeURIComponent(name)}) 
+    `,
+    'LICENSE.md': (
+      await fs.readFile(require.resolve(`./licenses/${license}.md`), 'utf8')
+    )
+      .replace(/<YEAR>/g, String(new Date().getFullYear()))
+      .replace(/<COPYRIGHT HOLDER>/g, copyrightHolder),
+  }
+  await Promise.all(
+    Object.entries(files).map(async ([name, content]) => {
+      const file = path.resolve(cwd, name)
+      await fs.writeFile(file, content, 'utf8')
+      // eslint-disable-next-line no-console
+      console.error(`wrote ${path.relative(process.cwd(), file)}`)
+    })
+  )
+
+  await execa('git', ['init'], { cwd })
+  await execa('git', ['remote', 'add', 'origin', packageJson.repository.url], {
+    cwd,
+  })
+  await execa(
+    'pnpm',
+    ['add', '-D', '--prefer-offline', '--no-optional', pkgName],
+    { cwd }
+  )
+  await execa('pnpm', ['exec', 'tc', 'init'], { cwd })
+
+  await execa('git', ['add', '.'], { cwd })
+  await execa('git', ['commit', '-m', 'chore: initial commit from tc create'], {
+    cwd,
+  })
+}
+
+exports.description = 'create a new toolchain project'
+exports.run = create
+
+const licenses = {
+  MIT: {
+    title: 'The MIT License',
+  },
+}

package/scripts/init.cjs

@@ -69,6 +69,8 @@ async function init(args = []) {
   await execa('pnpm', [
     'add',
     '-D',
+    '--no-optional',
+    '--prefer-offline',
     ...(isMonorepoRoot ? ['-w'] : []),
     isTest ? '../packages/base' : `${name}@^${version}`,
     ...(isTest

package/scripts/licenses/MIT.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <YEAR> <COPYRIGHT HOLDER>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/scripts/migrate.cjs

@@ -34,6 +34,8 @@ async function migrate(args = []) {
   if (!args.includes('--config-only')) {
     await execa('pnpm', [
       'i',
+      '--no-optional',
+      '--prefer-offline',
       '--fix-lockfile',
       ...(isMonorepoRoot ? ['-w'] : []),
     ])

package/scripts/toolchain.cjs

@@ -3,45 +3,56 @@
 const { name, version } = require('../package.json')
 const chalk = require('chalk')
 const getPluginsObjectSync = require('../util/getPluginsObjectSync.cjs')
-const { toolchainConfig } = require('../util/findUps.cjs')
 const execa = require('../util/execa.cjs')
 
-const scripts = {
-  migrate: require('./migrate.cjs'),
-  build: require('./build.cjs'),
-  'build:smoke-test': require('./smokeTestBuild.cjs'),
-  check: require('./check.cjs'),
-  clean: require('./clean.cjs'),
-  format: require('./format.cjs'),
-  init: require('./init.cjs'),
-  preinstall: require('./preinstall.cjs'),
-  lint: require('./lint.cjs'),
-  'lint:fix': require('./lint-fix.cjs'),
-  'open:coverage': require('./open-coverage.cjs'),
-  prepublish: require('./prepublish.cjs'),
-  upgrade: require('./upgrade.cjs'),
-  version: {
-    description: `print version of ${name}`,
-    run: () => {
-      // eslint-disable-next-line no-console
-      console.log(`${name}@${version}`)
-    },
-  },
-  'install-git-hooks': require('./install-git-hooks.cjs'),
-  ...getPluginsObjectSync('scripts'),
-  ...Object.fromEntries(
-    Object.entries(toolchainConfig.scripts || {}).map(([name, script]) => [
-      name,
-      typeof script === 'string'
-        ? {
-            run: (args = []) =>
-              execa([script, ...args].join(' '), { shell: true }),
-            description: script,
-          }
-        : script,
-    ])
-  ),
+let toolchainConfig
+try {
+  ;({ toolchainConfig } = require('../util/findUps.cjs'))
+} catch (error) {
+  if (!error.message.startsWith('failed to find project package.json')) {
+    throw error
+  }
 }
+const scripts = toolchainConfig
+  ? {
+      migrate: require('./migrate.cjs'),
+      build: require('./build.cjs'),
+      'build:smoke-test': require('./smokeTestBuild.cjs'),
+      check: require('./check.cjs'),
+      clean: require('./clean.cjs'),
+      format: require('./format.cjs'),
+      init: require('./init.cjs'),
+      preinstall: require('./preinstall.cjs'),
+      lint: require('./lint.cjs'),
+      'lint:fix': require('./lint-fix.cjs'),
+      'open:coverage': require('./open-coverage.cjs'),
+      prepublish: require('./prepublish.cjs'),
+      upgrade: require('./upgrade.cjs'),
+      version: {
+        description: `print version of ${name}`,
+        run: () => {
+          // eslint-disable-next-line no-console
+          console.log(`${name}@${version}`)
+        },
+      },
+      'install-git-hooks': require('./install-git-hooks.cjs'),
+      ...getPluginsObjectSync('scripts'),
+      ...Object.fromEntries(
+        Object.entries(toolchainConfig.scripts || {}).map(([name, script]) => [
+          name,
+          typeof script === 'string'
+            ? {
+                run: (args = []) =>
+                  execa([script, ...args].join(' '), { shell: true }),
+                description: script,
+              }
+            : script,
+        ])
+      ),
+    }
+  : {
+      create: require('./create.cjs'),
+    }
 
 exports.scripts = scripts
 

package/scripts/upgrade.cjs

@@ -22,6 +22,8 @@ async function upgrade([version] = []) {
   await execa('pnpm', [
     'add',
     '-D',
+    '--no-optional',
+    '--prefer-offline',
     ...(isMonorepoRoot ? ['-w'] : []),
     isTest ? '../packages/base' : `${name}@^${version}`,
     ...(isTest

package/util/execa.cjs

@@ -1,7 +1,6 @@
 const Path = require('path')
 const execa = require('execa')
 const chalk = require('chalk')
-const { projectDir, toolchainPackages } = require('./findUps.cjs')
 
 function formatArg(arg) {
   if (/^[-_a-z0-9=./]+$/i.test(arg)) return arg
@@ -15,6 +14,13 @@ function extractCommand(command) {
 }
 
 function getExecaArgs(command, args, options, ...rest) {
+  let projectDir, toolchainPackages
+  try {
+    ;({ projectDir, toolchainPackages } = require('./findUps.cjs'))
+  } catch (error) {
+    projectDir = process.cwd()
+    toolchainPackages = []
+  }
   if (args instanceof Object && !Array.isArray(args)) {
     options = args
     args = []

package/util/getPlugins.cjs

@@ -1,8 +1,8 @@
 const Path = require('path')
 const sortPlugins = require('./sortPlugins.cjs')
-const { projectDir, toolchainPackages } = require('./findUps.cjs')
 
 function getPlugins(name) {
+  const { projectDir, toolchainPackages } = require('./findUps.cjs')
   const plugins = {}
   for (const pkg of toolchainPackages) {
     let path