test-filesystem 1.0.0

package/gulpfile.js

@@ -0,0 +1,221 @@
+const babel = require('gulp-babel')
+const browserify = require('browserify')
+const { dest, parallel, series, src } = require('gulp')
+const { access, appendFileSync, constants, rm } = require('fs')
+const jsdoc2md = require('jsdoc-to-markdown')
+const { globSync } = require('glob')
+const merge = require('merge2')  // Requires separate installation
+const rename = require('gulp-rename')
+const { runCLI } = require('jest')
+const source = require('vinyl-source-stream')
+const standard = require('gulp-standard')
+const ts = require('gulp-typescript')
+const { default: uglify } = require('gulp-uglify-es')
+
+const browserName = 'test-fs'
+const browserPath = 'browser'
+const cleanFolders = ['dist', 'browser']
+const distSearch = 'dist/**/*js'
+const distMain = 'dist/cjs/main'
+const distPath = 'dist'
+const srcSearch = 'src/**/*.ts'
+const readmeTemplate = 'MAIN.md'
+const readmeFile = 'README.md'
+const readmePath = './'
+const readmeSearch = 'dist/cjs/**/*.js'
+const readmeOptions = 'utf8'
+const testPath = ['src']
+const testOptions = {
+  clearCache: false,
+  debug: false,
+  ignoreProjects: false,
+  json: false,
+  selectProjects: false,
+  showConfig: false,
+  useStderr: false,
+  watch: false,
+  watchAll: false,
+}
+const tsConfig = './tsconfig.json'
+const cjsPath = `${distPath}/cjs`
+const tsPath = `${distPath}/mjs`
+const tsSearch = `${distPath}/mjs/**/*.mjs`
+
+/**
+ * Return a promise to be completed once the specified directory is deleted.
+ * @function
+ * @memberOf module:test-fs
+ * @param {string} dirPath
+ * @returns {Promise<*>}
+ */
+const removeDirectory = (dirPath) => new Promise(
+  (resolve, reject) => access(
+    dirPath,
+    constants.F_OK,
+    (removed) => removed
+      ? resolve(dirPath)
+      : rm(
+        dirPath,
+        { recursive: true },
+        (error) => error ? reject(error) : resolve(dirPath)
+      )
+  )
+)
+
+/**
+ * Deletes all the distribution and browser files (used before create a new build).
+ * Configure array of directories to remove with 'cleanPaths'.
+ * @function
+ * @returns {Promise<string[]> | *}
+ */
+const clean = () => cleanFolders.reduce(
+  (promise, path) => promise.then(() => removeDirectory(path)),
+  Promise.resolve()
+)
+
+/**
+ * Starting at the source directory, find all the ts files and convert them into the distribution directory.
+ * @function
+ * @returns {Function}
+ * @see `https://www.typescriptlang.org/docs/handbook/gulp.html` for more info
+ */
+const typescript = () => {
+  const tsResult = src(srcSearch)
+    .pipe(ts({
+      declaration: true,
+      moduleResolution: 'node',
+      target: 'es6',
+      module: 'es2020'
+    }))
+  return merge([
+    tsResult.dts.pipe(dest(tsPath)),
+    tsResult.js.pipe(rename({ extname: '.mjs' })).pipe(dest(tsPath))
+  ])
+}
+
+/**
+ * When using TypeScript, ensure that we process the ts first then run babel (dist)
+ * @function
+ * @returns {function(null=): stream.Stream}
+ */
+const distSeries = (done = null) => {
+  const dist = () => src(tsSearch)
+    .pipe(babel())
+    .pipe(dest(cjsPath))
+  return series(typescript, dist)(done)
+}
+
+/**
+ * Applies Standard code style linting to distribution files.
+ * @function
+ * @returns {*}
+ */
+const distLint = () => src(distSearch)
+  .pipe(standard({ fix: true }))
+  .pipe(standard.reporter('default', {
+    fix: true,
+    quiet: true
+  }))
+  .pipe(dest(distPath))
+
+/**
+ * Creates minified versions of the dist files.
+ * @function
+ * @returns {*}
+ */
+const distMinify = () => src(distSearch)
+  .pipe(uglify())
+  .pipe(rename(path => {
+    if (path.extname) {
+      path.extname = `.min${path.extname}`
+    }
+  }))
+  .pipe(dest(distPath))
+
+/**
+ * Copy a readme template into the README.md file.
+ * @function
+ * @returns {*}
+ */
+const createReadme = () => src(readmeTemplate)
+  .pipe(rename(readmeFile))
+  .pipe(dest(readmePath))
+
+/**
+ * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
+ * Configure this with 'readmeSearch', 'readmePath', 'readmeFile', and 'readmeOptions'.
+ * @function
+ * @returns {string|Uint8Array}
+ */
+const addToReadme = () => jsdoc2md
+  .render({ files: globSync(readmeSearch) })
+  .then(
+    readme => appendFileSync(readmePath + readmeFile, readme, readmeOptions)
+  )
+
+/**
+ * Generate the readme file.
+ * @function
+ * @return {*}
+ */
+const buildReadme = (done = null) => series(createReadme, addToReadme)(done)
+
+/**
+ * Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
+ * @function
+ * @returns {stream.Stream}
+ */
+const bundle = () => browserify(distMain)
+  .bundle()
+  .pipe(source(`${browserName}.js`))
+  .pipe(dest(browserPath))
+
+/**
+ * Applies Standard code style linting to bundled file.
+ * @function
+ * @returns {stream.Stream}
+ */
+const bundleLint = () => src(`${browserPath}/${browserName}.js`)
+  .pipe(standard({ fix: true }))
+  .pipe(standard.reporter('default', {
+    fix: true,
+    quiet: true
+  }))
+  .pipe(dest(browserPath))
+
+/**
+ * Creates the minified bundle file.
+ * @function
+ * @returns {*}
+ */
+const bundleMinify = () => src(`${browserPath}/${browserName}.js`)
+  .pipe(uglify())
+  .pipe(rename({ extname: '.min.js' }))
+  .pipe(dest(browserPath))
+
+/**
+ * Run all tests with jest.
+ * Configure where tests are located by using 'testPath'.
+ * @function
+ * @returns {Promise<*>}
+ */
+const testFull = () => runCLI(testOptions, testPath)
+
+const build = (done = null) => parallel(
+  series(
+    clean,
+    distSeries,
+    parallel(distLint, distMinify),
+    buildReadme,
+    bundle,
+    parallel(bundleLint, bundleMinify)
+  ),
+  testFull
+)(done)
+
+exports.bundle = bundle
+exports.dist = distSeries
+exports.build = build
+exports.readme = buildReadme
+exports.testFull = testFull
+exports.typescript = typescript

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "test-filesystem",
+  "version": "1.0.0",
+  "description": "Set up and tear down a temp directory for running filesystem tests.",
+  "main": "dist/cjs/main.js",
+  "scripts": {
+    "build": "gulp build",
+    "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
+    "readme": "gulp readme",
+    "test": "gulp testFull"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jheagle/test-fs.git"
+  },
+  "keywords": [
+    "jest",
+    "testing",
+    "filesystem",
+    "fs",
+    "helpers"
+  ],
+  "author": "Joshua Heagle <joshuaheagle@gmail.com> (https://joshuaheagle.com)",
+  "license": "GPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/jheagle/test-fs/issues"
+  },
+  "homepage": "https://github.com/jheagle/test-fs#readme",
+  "dependencies": {
+    "fs": "^0.0.1-security",
+    "vinyl-source-stream": "^2.0.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.7",
+    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
+    "babel-jest": "^29.7.0",
+    "browserify": "^17.0.0",
+    "glob": "^10.3.10",
+    "gulp": "^4.0.2",
+    "gulp-babel": "^8.0.0",
+    "gulp-rename": "^2.0.0",
+    "gulp-standard": "^14.0.0",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "gulp-uglify-es": "^3.0.0",
+    "jest": "^29.7.0",
+    "jsdoc-to-markdown": "^8.0.0",
+    "merge2": "^1.4.1"
+  },
+  "engines": {
+    "node": ">=10.2.1"
+  },
+  "files":  [
+    "browser",
+    "dist",
+    "gulpfile.js"
+  ]
+}