@vanillaes/esmtk 1.4.1 → 1.5.0

package/bin/commands/clean.js

@@ -33,6 +33,7 @@ export async function clean (cwd, options) {
 
 /**
  * Run one category of build artifacts
+ * @private
  * @param {string} cwd the current working directory (default process.cwd())
  * @param {string} glob the pattern of files to match
  * @param {object} options 'clean' options

package/bin/commands/init.js

@@ -113,6 +113,7 @@ export async function init (options) {
 
 /**
  * Ask a question on the command-line
+ * @private
  * @param {object} program reference to the CLI
  * @param {string} prompt the question to ask the User
  * @param {string} [defaultValue] the default value for the question
@@ -126,6 +127,7 @@ async function ask (program, prompt, defaultValue) {
 
 /**
  * Fetch the user.name from .gitconfig
+ * @private
  * @returns {Promise<string>} the user.name
  */
 async function fetchGitUser () {
@@ -139,6 +141,7 @@ async function fetchGitUser () {
 
 /**
  * Fetch the user.email from .gitconfig
+ * @private
  * @returns {Promise<string>} the user.email
  */
 async function fetchGitEmail () {
@@ -152,6 +155,7 @@ async function fetchGitEmail () {
 
 /**
  * Fetch the repository name from .git/config
+ * @private
  * @returns {Promise<string>} the repository name
  */
 async function fetchGitRepository () {

package/bin/commands/preview.js

@@ -1,6 +1,5 @@
-import { match } from '../../src/util.js'
+import { match, readNPMIgnore } from '../../src/util.js'
 import { statSync } from 'node:fs'
-import { readFile } from 'node:fs/promises'
 import { dirname, join } from 'node:path'
 
 import { createRequire } from 'module'
@@ -33,23 +32,9 @@ export async function preview (options) {
   console.log()
 }
 
-/**
- * Read .npmignore
- * @param {string} cwd the current working directory
- * @returns {Promise<string>} a comma-deliminated list of ignore globs
- */
-async function readNPMIgnore (cwd) {
-  const path = join(cwd, '.npmignore')
-  const contents = await readFile(path, 'utf8')
-  return contents
-    .split('\n')
-    .map(line => line.trim())
-    .filter(line => line && !line.startsWith('#'))
-    .join(',')
-}
-
 /**
  * File list comparator
+ * @private
  * @param {string} a file path a
  * @param {string} b file path b
  * @returns {number} 1 | -1
@@ -68,6 +53,7 @@ function fileCompare (a, b) {
 
 /**
  * Format a file path to include file size
+ * @private
  * @param {string} path the file path
  * @returns {string} file size followed by file path
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
@@ -25,16 +25,16 @@
   },
   "exports": {
     ".": {
-      "types": "./src/index.d.ts",
-      "default": "./src/index.js"
+      "import": "./src/index.js",
+      "types": "./src/index.d.ts"
     },
     "./cp": {
-      "types": "./src/cp.d.ts",
-      "default": "./src/cp.js"
+      "import": "./src/cp.js",
+      "types": "./src/cp.d.ts"
     },
     "./rm": {
-      "types": "./src/rm.d.ts",
-      "default": "./src/rm.js"
+      "import": "./src/rm.js",
+      "types": "./src/rm.d.ts"
     }
   },
   "scripts": {

package/src/index.d.ts

@@ -1,3 +1,3 @@
 export { copyAsync, copyMultipleAsync, copyRecursiveAsync } from "./cp.js";
 export { removeAsync, removeMultipleAsync, removeRecursiveAsync } from "./rm.js";
-export { expand, fileExists, installed, match, which } from "./util.js";
+export { expand, fileExists, installed, match, readGitIgnore, readNPMIgnore, which } from "./util.js";

package/src/index.js

@@ -1,3 +1,3 @@
 export { copyAsync, copyMultipleAsync, copyRecursiveAsync } from './cp.js'
 export { removeAsync, removeMultipleAsync, removeRecursiveAsync } from './rm.js'
-export { expand, fileExists, installed, match, which } from './util.js'
+export { expand, fileExists, installed, match, readGitIgnore, readNPMIgnore, which } from './util.js'

package/src/util.d.ts

@@ -24,6 +24,18 @@ export function installed(pkg: string): Promise<boolean>;
  * @returns {Promise<string[]>} an array of paths
  */
 export function match(pattern: string, cwd?: string, ignore?: string): Promise<string[]>;
+/**
+ * Read .gitignore
+ * @param {string} cwd the current working directory
+ * @returns {Promise<string[]>} a comma-deliminated list of ignore globs
+ */
+export function readGitIgnore(cwd: string): Promise<string[]>;
+/**
+ * Read .npmignore
+ * @param {string} cwd the current working directory
+ * @returns {Promise<string>} a comma-deliminated list of ignore globs
+ */
+export function readNPMIgnore(cwd: string): Promise<string>;
 /**
  * Check to see if an application is installed globally
  * @param {string} program the name of the application

package/src/util.js

@@ -1,5 +1,6 @@
 import { exec } from 'child_process'
-import { access, constants, glob } from 'node:fs/promises'
+import { join } from 'node:path'
+import { access, constants, glob, readFile } from 'node:fs/promises'
 import { promisify } from 'node:util'
 
 const execAsync = promisify(exec)
@@ -74,6 +75,39 @@ export async function match (pattern, cwd = process.cwd(), ignore = null) {
   return await Array.fromAsync(glob(patterns, { cwd }))
 }
 
+/**
+ * Read .gitignore
+ * @param {string} cwd the current working directory
+ * @returns {Promise<string[]>} a comma-deliminated list of ignore globs
+ */
+export async function readGitIgnore (cwd) {
+  const path = join(cwd, '.gitignore')
+  const exists = await fileExists(path)
+  if (!exists) {
+    return []
+  }
+  const contents = await readFile(path, 'utf8')
+  return contents
+    .split('\n')
+    .map(line => line.trim())
+    .filter(line => line && !line.startsWith('#'))
+}
+
+/**
+ * Read .npmignore
+ * @param {string} cwd the current working directory
+ * @returns {Promise<string>} a comma-deliminated list of ignore globs
+ */
+export async function readNPMIgnore (cwd) {
+  const path = join(cwd, '.npmignore')
+  const contents = await readFile(path, 'utf8')
+  return contents
+    .split('\n')
+    .map(line => line.trim())
+    .filter(line => line && !line.startsWith('#'))
+    .join(',')
+}
+
 /**
  * Check to see if an application is installed globally
  * @param {string} program the name of the application