@napi-rs/cli 2.15.1 → 3.0.0-alpha.0

package/src/api/new.ts

@@ -0,0 +1,206 @@
+import path from 'path'
+
+import {
+  applyDefaultNewOptions,
+  NewOptions as RawNewOptions,
+} from '../def/new.js'
+import {
+  AVAILABLE_TARGETS,
+  CLI_VERSION,
+  debugFactory,
+  DEFAULT_TARGETS,
+  mkdirAsync,
+  writeFileAsync,
+} from '../utils/index.js'
+import { napiEngineRequirement } from '../utils/version.js'
+
+import {
+  createBuildRs,
+  createCargoToml,
+  createGithubActionsCIYml,
+  createLibRs,
+  createPackageJson,
+  gitIgnore,
+  npmIgnore,
+} from './templates/index.js'
+
+const debug = debugFactory('new')
+
+interface Output {
+  target: string
+  content: string
+}
+
+type NewOptions = Required<RawNewOptions>
+
+function processOptions(options: RawNewOptions) {
+  debug('Processing options...')
+  options.path = path.resolve(process.cwd(), options.path)
+  debug(`Resolved target path to: ${options.path}`)
+
+  if (!options.name) {
+    options.name = path.parse(options.path).base
+    debug(`No project name provided, fix it to dir name: ${options.name}`)
+  }
+
+  if (!options.targets?.length) {
+    if (options.enableAllTargets) {
+      options.targets = AVAILABLE_TARGETS.concat()
+      debug('Enable all targets')
+    } else if (options.enableDefaultTargets) {
+      options.targets = DEFAULT_TARGETS.concat()
+      debug('Enable default targets')
+    } else {
+      throw new Error('At least one target must be enabled')
+    }
+  }
+
+  return applyDefaultNewOptions(options) as NewOptions
+}
+
+export async function newProject(userOptions: RawNewOptions) {
+  debug('Will create napi-rs project with given options:')
+  debug(userOptions)
+
+  const options = processOptions(userOptions)
+
+  debug('Targets to be enabled:')
+  debug(options.targets)
+
+  const outputs = generateFiles(options)
+
+  try {
+    debug(`Try to create target directory: ${options.path}`)
+    if (!options.dryRun) {
+      await mkdirAsync(options.path, { recursive: true })
+    }
+  } catch (e) {
+    throw new Error(`Failed to create target directory: ${options.path}`, {
+      cause: e,
+    })
+  }
+
+  await dumpOutputs(outputs, options.dryRun)
+  debug(`Project created at: ${options.path}`)
+}
+
+function generateFiles(options: NewOptions): Output[] {
+  return [
+    generateCargoToml,
+    generateLibRs,
+    generateBuildRs,
+    generatePackageJson,
+    generateGithubWorkflow,
+    generateIgnoreFiles,
+  ].flatMap((generator) => {
+    const output = generator(options)
+
+    if (!output) {
+      return []
+    }
+
+    if (Array.isArray(output)) {
+      return output.map((o) => ({
+        ...o,
+        target: path.join(options.path, o.target),
+      }))
+    } else {
+      return [{ ...output, target: path.join(options.path, output.target) }]
+    }
+  })
+}
+
+function generateCargoToml(options: NewOptions): Output {
+  return {
+    target: './Cargo.toml',
+    content: createCargoToml({
+      name: options.name,
+      license: options.license,
+      features: [`napi${options.minNodeApiVersion}`],
+      deriveFeatures: options.enableTypeDef ? ['type-def'] : [],
+    }),
+  }
+}
+
+function generateLibRs(_options: NewOptions): Output {
+  return {
+    target: './src/lib.rs',
+    content: createLibRs(),
+  }
+}
+
+function generateBuildRs(_options: NewOptions): Output {
+  return {
+    target: './build.rs',
+    content: createBuildRs(),
+  }
+}
+
+function generatePackageJson(options: NewOptions): Output {
+  return {
+    target: './package.json',
+    content: createPackageJson({
+      name: options.name,
+      binaryName: getBinaryName(options.name),
+      targets: options.targets,
+      license: options.license,
+      engineRequirement: napiEngineRequirement(options.minNodeApiVersion),
+      cliVersion: CLI_VERSION,
+    }),
+  }
+}
+
+function generateGithubWorkflow(options: NewOptions): Output | null {
+  if (!options.enableGithubActions) {
+    return null
+  }
+
+  return {
+    target: './.github/workflows/ci.yml',
+    content: createGithubActionsCIYml(
+      getBinaryName(options.name),
+      options.targets,
+    ),
+  }
+}
+
+function generateIgnoreFiles(_options: NewOptions): Output[] {
+  return [
+    {
+      target: './.gitignore',
+      content: gitIgnore,
+    },
+    {
+      target: './.npmignore',
+      content: npmIgnore,
+    },
+  ]
+}
+
+async function dumpOutputs(outputs: Output[], dryRun?: boolean) {
+  for (const output of outputs) {
+    if (!output) {
+      continue
+    }
+
+    debug(`Writing project file: ${output.target}`)
+    // only output content to logger instead of writing to file system
+    if (dryRun) {
+      debug(output.content)
+      continue
+    }
+
+    try {
+      await mkdirAsync(path.dirname(output.target), { recursive: true })
+      await writeFileAsync(output.target, output.content, 'utf-8')
+    } catch (e) {
+      throw new Error(`Failed to write file: ${output.target}`, { cause: e })
+    }
+  }
+}
+
+function getBinaryName(name: string): string {
+  return name.split('/').pop()!
+}
+
+export { NewOptions }

package/src/api/pre-publish.ts

@@ -0,0 +1,216 @@
+import { execSync } from 'child_process'
+import { existsSync, statSync } from 'fs'
+import { join, relative, resolve } from 'path'
+
+import { Octokit } from '@octokit/rest'
+
+import {
+  applyDefaultPrePublishOptions,
+  PrePublishOptions,
+} from '../def/pre-publish.js'
+import {
+  readFileAsync,
+  readNapiConfig,
+  debugFactory,
+  updatePackageJson,
+} from '../utils/index.js'
+
+import { version } from './version.js'
+
+const debug = debugFactory('pre-publish')
+
+interface PackageInfo {
+  name: string
+  version: string
+  tag: string
+}
+
+export async function prePublish(userOptions: PrePublishOptions) {
+  debug('Receive pre-publish options:')
+  debug('  %O', userOptions)
+
+  const options = applyDefaultPrePublishOptions(userOptions)
+
+  const packageJsonPath = relative(options.cwd, options.packageJsonPath)
+
+  const { packageJson, targets, packageName, binaryName, npmClient } =
+    await readNapiConfig(packageJsonPath)
+
+  async function createGhRelease(packageName: string, version: string) {
+    if (!options.ghRelease) {
+      return {
+        owner: null,
+        repo: null,
+        pkgInfo: { name: null, version: null, tag: null },
+      }
+    }
+    const { repo, owner, pkgInfo, octokit } = getRepoInfo(packageName, version)
+
+    if (!repo || !owner) {
+      return {
+        owner: null,
+        repo: null,
+        pkgInfo: { name: null, version: null, tag: null },
+      }
+    }
+
+    if (!options.dryRun) {
+      try {
+        await octokit.repos.createRelease({
+          owner,
+          repo,
+          tag_name: pkgInfo.tag,
+          name: options.ghReleaseName,
+          prerelease:
+            version.includes('alpha') ||
+            version.includes('beta') ||
+            version.includes('rc'),
+        })
+      } catch (e) {
+        debug(
+          `Params: ${JSON.stringify(
+            { owner, repo, tag_name: pkgInfo.tag },
+            null,
+            2,
+          )}`,
+        )
+        console.error(e)
+      }
+    }
+    return { owner, repo, pkgInfo, octokit }
+  }
+
+  function getRepoInfo(packageName: string, version: string) {
+    const headCommit = execSync('git log -1 --pretty=%B', {
+      encoding: 'utf-8',
+    }).trim()
+
+    const { GITHUB_REPOSITORY } = process.env
+    if (!GITHUB_REPOSITORY) {
+      return {
+        owner: null,
+        repo: null,
+        pkgInfo: { name: null, version: null, tag: null },
+      }
+    }
+    debug(`Github repository: ${GITHUB_REPOSITORY}`)
+    const [owner, repo] = GITHUB_REPOSITORY.split('/')
+    const octokit = new Octokit({
+      auth: process.env.GITHUB_TOKEN,
+    })
+    let pkgInfo: PackageInfo | undefined
+    if (options.tagStyle === 'lerna') {
+      const packagesToPublish = headCommit
+        .split('\n')
+        .map((line) => line.trim())
+        .filter((line, index) => line.length && index)
+        .map((line) => line.substring(2))
+        .map(parseTag)
+
+      pkgInfo = packagesToPublish.find(
+        (pkgInfo) => pkgInfo.name === packageName,
+      )
+
+      if (!pkgInfo) {
+        throw new TypeError(
+          `No release commit found with ${packageName}, original commit info: ${headCommit}`,
+        )
+      }
+    } else {
+      pkgInfo = {
+        tag: `v${version}`,
+        version,
+        name: packageName,
+      }
+    }
+    return { owner, repo, pkgInfo, octokit }
+  }
+
+  if (!options.dryRun) {
+    await version(userOptions)
+    await updatePackageJson(packageJsonPath, {
+      optionalDependencies: targets.reduce((deps, target) => {
+        deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
+
+        return deps
+      }, {} as Record<string, string>),
+    })
+  }
+
+  const { owner, repo, pkgInfo, octokit } = options.ghReleaseId
+    ? getRepoInfo(packageName, packageJson.version)
+    : await createGhRelease(packageName, packageJson.version)
+
+  for (const target of targets) {
+    const pkgDir = resolve(
+      options.cwd,
+      options.npmDir,
+      `${target.platformArchABI}`,
+    )
+    const filename = `${binaryName}.${target.platformArchABI}.node`
+    const dstPath = join(pkgDir, filename)
+
+    if (!options.dryRun) {
+      if (!existsSync(dstPath)) {
+        debug.warn(`%s doesn't exist`, dstPath)
+        continue
+      }
+
+      execSync(`${npmClient} publish`, {
+        cwd: pkgDir,
+        env: process.env,
+      })
+
+      if (options.ghRelease && repo && owner) {
+        debug.info(`Creating GitHub release ${pkgInfo.tag}`)
+        try {
+          const releaseId = options.ghReleaseId
+            ? Number(options.ghReleaseId)
+            : (
+                await octokit!.repos.getReleaseByTag({
+                  repo: repo,
+                  owner: owner,
+                  tag: pkgInfo.tag,
+                })
+              ).data.id
+          const dstFileStats = statSync(dstPath)
+          const assetInfo = await octokit!.repos.uploadReleaseAsset({
+            owner: owner,
+            repo: repo,
+            name: filename,
+            release_id: releaseId,
+            mediaType: { format: 'raw' },
+            headers: {
+              'content-length': dstFileStats.size,
+              'content-type': 'application/octet-stream',
+            },
+            data: await readFileAsync(dstPath, { encoding: 'utf-8' }),
+          })
+          debug.info(`GitHub release created`)
+          debug.info(`Download URL: %s`, assetInfo.data.browser_download_url)
+        } catch (e) {
+          debug.error(
+            `Param: ${JSON.stringify(
+              { owner, repo, tag: pkgInfo.tag, filename: dstPath },
+              null,
+              2,
+            )}`,
+          )
+          debug.error(e)
+        }
+      }
+    }
+  }
+}
+
+function parseTag(tag: string) {
+  const segments = tag.split('@')
+  const version = segments.pop()!
+  const name = segments.join('@')
+
+  return {
+    name,
+    version,
+    tag,
+  }
+}

package/src/api/rename.ts

@@ -0,0 +1,51 @@
+import { resolve } from 'path'
+
+import { isNil, merge, omitBy, pick } from 'lodash-es'
+
+import { applyDefaultRenameOptions, RenameOptions } from '../def/rename.js'
+import { readFileAsync, writeFileAsync } from '../utils/index.js'
+
+import { createNpmDirs } from './create-npm-dirs.js'
+
+export async function renameProject(userOptions: RenameOptions) {
+  const options = applyDefaultRenameOptions(userOptions)
+
+  const packageJsonPath = resolve(options.cwd, options.packageJsonPath)
+  const cargoTomlPath = resolve(options.cwd, options.manifestPath)
+
+  const packageJsonContent = await readFileAsync(packageJsonPath, 'utf8')
+  const packageJsonData = JSON.parse(packageJsonContent)
+
+  merge(
+    packageJsonData,
+    omitBy(pick(options, ['name', 'description', 'author', 'license']), isNil),
+    {
+      napi: omitBy(
+        {
+          binaryName: options.binaryName,
+          packageName: options.packageName,
+        },
+        isNil,
+      ),
+    },
+  )
+
+  await writeFileAsync(
+    packageJsonPath,
+    JSON.stringify(packageJsonData, null, 2),
+  )
+
+  let tomlContent = await readFileAsync(cargoTomlPath, 'utf8')
+  tomlContent = tomlContent.replace(
+    /name\s?=\s?"([\w+])"/,
+    `name = "${options.binaryName}"`,
+  )
+  await writeFileAsync(cargoTomlPath, tomlContent)
+
+  await createNpmDirs({
+    cwd: options.cwd,
+    packageJsonPath: options.packageJsonPath,
+    npmDir: options.npmDir,
+    dryRun: false,
+  })
+}

package/src/api/templates/.gitignore.ts

@@ -0,0 +1,198 @@
+export const gitIgnore = `# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# End of https://www.toptal.com/developers/gitignore/api/node
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos
+
+# Created by https://www.toptal.com/developers/gitignore/api/windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=windows
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/windows
+
+#Added by cargo
+
+/target
+Cargo.lock
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+*.node
+`

package/src/api/templates/.npmignore.ts

@@ -0,0 +1,14 @@
+export const npmIgnore = `target
+Cargo.lock
+.cargo
+.github
+npm
+.eslintrc
+.prettierignore
+rustfmt.toml
+yarn.lock
+*.node
+.yarn
+__test__
+renovate.json
+`

package/src/api/templates/build.rs.ts

@@ -0,0 +1,4 @@
+export const createBuildRs = () => `fn main() {
+  napi_build::setup();
+}
+`