.github/workflows/static.yml

@@ -0,0 +1,49 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Use Nodejs ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+      - name: Install dependencies
+        run: npm install
+      - name: Generate typedocs
+        run: npm run typedoc
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/typedoc.yml

@@ -0,0 +1,50 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Use Nodejs ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+      - name: Install dependencies
+        run: npm install
+      - name: Generate typedocs
+        run: npm run typedoc
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -2,3 +2,6 @@
 /.nyc_output
 /coverage
 /dist
+!/typedoc.json
+!/tsconfig-*.json
+!/.prettierignore

CHANGELOG.md

@@ -1,7 +1,7 @@
 # v4.1
 
 - Improved hybrid module with no need to look at the `.default`
-  dangly bit.  `.default` preserved as a reference to `rimraf`
+  dangly bit. `.default` preserved as a reference to `rimraf`
   for compatibility with anyone who came to rely on it in v4.0.
 - Accept and ignore `-rf` and `-fr` arguments to the bin.
 
@@ -15,8 +15,8 @@
 - Drop support for Node.js below version 14
 - rewrite in TypeScript
 - ship CJS/ESM hybrid module
-- Error on ignore unknown arguments to the bin. (Previously they
-  were silently ignored.)
+- Error on unknown arguments to the bin. (Previously they were
+  silently ignored.)
 
 # v3.0
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rimraf",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "main": "./dist/cjs/src/index-cjs.js",
   "module": "./dist/mjs/index.js",
   "bin": "./dist/cjs/src/bin.js",

test/default-tmp.js

@@ -2,9 +2,12 @@ const t = require('tap')
 
 t.test('posix platform', async t => {
   const { tmpdir } = require('os')
-  const { defaultTmp, defaultTmpSync } = t.mock('../dist/cjs/src/default-tmp.js', {
-    '../dist/cjs/src/platform.js': 'posix',
-  })
+  const { defaultTmp, defaultTmpSync } = t.mock(
+    '../dist/cjs/src/default-tmp.js',
+    {
+      '../dist/cjs/src/platform.js': 'posix',
+    }
+  )
   t.equal(defaultTmpSync('anything'), tmpdir())
   t.equal(await defaultTmp('anything').then(t => t), tmpdir())
 })
@@ -20,19 +23,22 @@ t.test('windows', async t => {
         throw Object.assign(new Error('no ents here'), { code: 'ENOENT' })
     }
   }
-  const { defaultTmp, defaultTmpSync } = t.mock('../dist/cjs/src/default-tmp.js', {
-    os: {
-      tmpdir: () => 'C:\\Windows\\Temp',
-    },
-    path: require('path').win32,
-    '../dist/cjs/src/platform.js': 'win32',
-    '../dist/cjs/src/fs.js': {
-      statSync: tempDirCheck,
-      promises: {
-        stat: async path => tempDirCheck(path),
+  const { defaultTmp, defaultTmpSync } = t.mock(
+    '../dist/cjs/src/default-tmp.js',
+    {
+      os: {
+        tmpdir: () => 'C:\\Windows\\Temp',
+      },
+      path: require('path').win32,
+      '../dist/cjs/src/platform.js': 'win32',
+      '../dist/cjs/src/fs.js': {
+        statSync: tempDirCheck,
+        promises: {
+          stat: async path => tempDirCheck(path),
+        },
       },
-    },
-  })
+    }
+  )
 
   const expect = {
     'c:\\some\\path': 'C:\\Windows\\Temp',

test/delete-many-files.js

@@ -13,11 +13,7 @@ const START = (process.env.RIMRAF_TEST_START_CHAR || 'a').charCodeAt(0)
 const END = (process.env.RIMRAF_TEST_END_CHAR || 'f').charCodeAt(0)
 const DEPTH = +process.env.RIMRAF_TEST_DEPTH || 4
 
-const {
-  statSync,
-  mkdirSync,
-  readdirSync,
-} = require('../dist/cjs/src/fs.js')
+const { statSync, mkdirSync, readdirSync } = require('../dist/cjs/src/fs.js')
 const { writeFileSync } = require('fs')
 const { resolve, dirname } = require('path')
 

test/ignore-enoent.js

@@ -1,5 +1,8 @@
 const t = require('tap')
-const { ignoreENOENT, ignoreENOENTSync } = require('../dist/cjs/src/ignore-enoent.js')
+const {
+  ignoreENOENT,
+  ignoreENOENTSync,
+} = require('../dist/cjs/src/ignore-enoent.js')
 
 const enoent = Object.assign(new Error('no ent'), { code: 'ENOENT' })
 const eperm = Object.assign(new Error('eperm'), { code: 'EPERM' })

test/rimraf-manual.js

@@ -1,10 +1,19 @@
 const t = require('tap')
 
-const { rimrafWindows, rimrafWindowsSync } = require('../dist/cjs/src/rimraf-windows.js')
+const {
+  rimrafWindows,
+  rimrafWindowsSync,
+} = require('../dist/cjs/src/rimraf-windows.js')
 
-const { rimrafPosix, rimrafPosixSync } = require('../dist/cjs/src/rimraf-posix.js')
+const {
+  rimrafPosix,
+  rimrafPosixSync,
+} = require('../dist/cjs/src/rimraf-posix.js')
 
-const { rimrafManual, rimrafManualSync } = require('../dist/cjs/src/rimraf-manual.js')
+const {
+  rimrafManual,
+  rimrafManualSync,
+} = require('../dist/cjs/src/rimraf-manual.js')
 
 if (!process.env.__TESTING_RIMRAF_PLATFORM__) {
   const otherPlatform = process.platform !== 'win32' ? 'win32' : 'posix'

test/rimraf-move-remove.js

@@ -57,9 +57,12 @@ t.only('actually delete some stuff', async t => {
   // but actually do wait to clean them up, though
   t.teardown(() => Promise.all(danglers))
 
-  const { rimrafPosix, rimrafPosixSync } = t.mock('../dist/cjs/src/rimraf-posix.js', {
-    '../dist/cjs/src/fs.js': fsMock,
-  })
+  const { rimrafPosix, rimrafPosixSync } = t.mock(
+    '../dist/cjs/src/rimraf-posix.js',
+    {
+      '../dist/cjs/src/fs.js': fsMock,
+    }
+  )
 
   const { rimrafMoveRemove, rimrafMoveRemoveSync } = t.mock(
     '../dist/cjs/src/rimraf-move-remove.js',

test/rimraf-native.js

@@ -12,9 +12,12 @@ const fs = {
   },
 }
 
-const { rimrafNative, rimrafNativeSync } = t.mock('../dist/cjs/src/rimraf-native.js', {
-  '../dist/cjs/src/fs.js': fs,
-})
+const { rimrafNative, rimrafNativeSync } = t.mock(
+  '../dist/cjs/src/rimraf-native.js',
+  {
+    '../dist/cjs/src/fs.js': fs,
+  }
+)
 
 t.test('calls the right node function', async t => {
   await rimrafNative('path', { x: 'y' })