3.0.3

Add my own website in README.md

.github/workflows/neocities.yml

@@ -5,7 +5,7 @@ on:
   push:
     branches:
       - master
-      
+
 env:
   FORCE_COLOR: 1
   node_version: lts/*
@@ -32,7 +32,9 @@ jobs:
     - name: Deploy to neocities
       uses: bcomnes/deploy-to-neocities@master # dont use master in production
       with:
-        api_token: ${{ secrets.NEOCITIES_API_TOKEN }}
+        api_key: ${{ secrets.NEOCITIES_API_TOKEN }}
         cleanup: true
         dist_dir: public
         protected_files: 'dropbox/*'
+        neocities_supporter: true # set this to true if you have a supporter account and want to bypass unsuported files filter.
+        preview_before_deploy: true

.gitignore

@@ -5,3 +5,4 @@ public
 node_modules
 tmp_modules
 package-lock.json
+coverage

CHANGELOG.md

@@ -7,7 +7,88 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-## [v2.0.0](https://github.com/bcomnes/deploy-to-neocities/compare/v1.1.21...v2.0.0)
+## [v3.0.3](https://github.com/bcomnes/deploy-to-neocities/compare/v3.0.2...v3.0.3)
+
+### Merged
+
+- Add my own website in README.md [`#222`](https://github.com/bcomnes/deploy-to-neocities/pull/222)
+- chore(deps-dev): bump typescript from 5.7.3 to 5.8.2 [`#217`](https://github.com/bcomnes/deploy-to-neocities/pull/217)
+- chore(deps-dev): bump esbuild from 0.24.2 to 0.25.0 [`#213`](https://github.com/bcomnes/deploy-to-neocities/pull/213)
+- chore(deps-dev): bump neostandard from 0.11.9 to 0.12.0 [`#211`](https://github.com/bcomnes/deploy-to-neocities/pull/211)
+
+### Commits
+
+- Update async-neocities [`51ec937`](https://github.com/bcomnes/deploy-to-neocities/commit/51ec937eb84fa6beae055593f8e286e7d49d1d1e)
+- Merge pull request #221 from bcomnes/dependabot/npm_and_yarn/npm-run-all2-8.0.1 [`7c11b66`](https://github.com/bcomnes/deploy-to-neocities/commit/7c11b664c6b9ed5b7d72def8047f539b2f2205a9)
+- More example comments [`5761b44`](https://github.com/bcomnes/deploy-to-neocities/commit/5761b44f4df0408697ca3c9438cf8f7ae8df9628)
+
+## [v3.0.2](https://github.com/bcomnes/deploy-to-neocities/compare/v3.0.1...v3.0.2) - 2024-12-09
+
+### Merged
+
+- chore(deps): bump async-neocities from 4.0.4 to 4.1.0 [`#210`](https://github.com/bcomnes/deploy-to-neocities/pull/210)
+
+## [v3.0.1](https://github.com/bcomnes/deploy-to-neocities/compare/v3.0.0...v3.0.1) - 2024-11-28
+
+### Merged
+
+- chore(deps): bump async-neocities from 4.0.3 to 4.0.4 [`#209`](https://github.com/bcomnes/deploy-to-neocities/pull/209)
+- fixed a typo in README.md [`#208`](https://github.com/bcomnes/deploy-to-neocities/pull/208)
+- chore(deps-dev): bump typescript from 5.6.3 to 5.7.2 [`#207`](https://github.com/bcomnes/deploy-to-neocities/pull/207)
+- Add my website https://jefbecker.com/ to the list. [`#206`](https://github.com/bcomnes/deploy-to-neocities/pull/206)
+
+### Commits
+
+- Update README.md [`15eb88d`](https://github.com/bcomnes/deploy-to-neocities/commit/15eb88d4831e8b3170195c1e2b468e8ab3a9703d)
+
+## [v3.0.0](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.4...v3.0.0) - 2024-11-19
+
+### Merged
+
+- chore(deps-dev): bump npm-run-all2 from 6.2.6 to 7.0.1 [`#205`](https://github.com/bcomnes/deploy-to-neocities/pull/205)
+
+### Commits
+
+- **Breaking change:** Update to the latest async-neocities 4.0 [`7b14798`](https://github.com/bcomnes/deploy-to-neocities/commit/7b14798c892f2494466bc72d5402c85801f75341)
+
+## [v2.0.4](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.3...v2.0.4) - 2024-10-07
+
+### Merged
+
+- chore(deps-dev): bump top-bun from 9.1.1 to 10.0.0 [`#202`](https://github.com/bcomnes/deploy-to-neocities/pull/202)
+- chore(deps): bump @actions/core from 1.11.0 to 1.11.1 [`#203`](https://github.com/bcomnes/deploy-to-neocities/pull/203)
+
+## [v2.0.3](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.2...v2.0.3) - 2024-10-03
+
+### Merged
+
+- chore(deps): bump @actions/core from 1.10.1 to 1.11.0 [`#201`](https://github.com/bcomnes/deploy-to-neocities/pull/201)
+- Add my site to the readme [`#200`](https://github.com/bcomnes/deploy-to-neocities/pull/200)
+- chore(deps-dev): bump top-bun from 8.0.2 to 9.0.1 [`#197`](https://github.com/bcomnes/deploy-to-neocities/pull/197)
+- chore(deps-dev): bump top-bun from 7.3.4 to 8.0.0 [`#193`](https://github.com/bcomnes/deploy-to-neocities/pull/193)
+- chore(deps): bump minimatch from 9.0.5 to 10.0.1 [`#192`](https://github.com/bcomnes/deploy-to-neocities/pull/192)
+- Remove my hobby website from the website list [`#188`](https://github.com/bcomnes/deploy-to-neocities/pull/188)
+- chore(deps-dev): bump esbuild from 0.20.2 to 0.21.0 [`#184`](https://github.com/bcomnes/deploy-to-neocities/pull/184)
+
+### Commits
+
+- Merge pull request #199 from bcomnes/dependabot/npm_and_yarn/esbuild-0.24.0 [`f2bd635`](https://github.com/bcomnes/deploy-to-neocities/commit/f2bd635f4250c0f0c3dbf2fbced0be3608c96f2d)
+- chore(deps-dev): bump esbuild from 0.23.1 to 0.24.0 [`90e8a07`](https://github.com/bcomnes/deploy-to-neocities/commit/90e8a074cd8aef07020ac80fbc420ee0a4189615)
+- Merge pull request #191 from bcomnes/dependabot/npm_and_yarn/esbuild-0.23.0 [`8999c71`](https://github.com/bcomnes/deploy-to-neocities/commit/8999c710228c8627186a5360a882117a20c16cc1)
+
+## [v2.0.2](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.1...v2.0.2) - 2024-04-04
+
+### Commits
+
+- Clarify default branch situation in README [`1fcd576`](https://github.com/bcomnes/deploy-to-neocities/commit/1fcd576de99dc8f39086f7239bf22962f3b8e7ae)
+
+## [v2.0.1](https://github.com/bcomnes/deploy-to-neocities/compare/v2.0.0...v2.0.1) - 2024-04-04
+
+### Commits
+
+- Update docs [`5a66259`](https://github.com/bcomnes/deploy-to-neocities/commit/5a66259a88059e84b1a3981aa88389854700f8a8)
+
+## [v2.0.0](https://github.com/bcomnes/deploy-to-neocities/compare/v1.1.21...v2.0.0) - 2024-04-04
 
 ### Merged
 
@@ -273,8 +354,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 ### Commits
 
-- Update site build and ncc [`def67b4`](https://github.com/bcomnes/deploy-to-neocities/commit/def67b48c6e28d4544d8dd2bd92ab53f56856e40)
 - Fix static deploy stuff with bandaid [`fea2d47`](https://github.com/bcomnes/deploy-to-neocities/commit/fea2d4780c7a98bcdf5738c1c259d66ff115326a)
+- Update site build and ncc [`def67b4`](https://github.com/bcomnes/deploy-to-neocities/commit/def67b48c6e28d4544d8dd2bd92ab53f56856e40)
 
 ## [v1.1.1](https://github.com/bcomnes/deploy-to-neocities/compare/v1.1.0...v1.1.1) - 2021-08-20
 

README.md

@@ -10,16 +10,18 @@
 
 Efficiently deploy a website to [Neocities][nc] using [Github actions](https://github.com/features/actions).  Uses content aware diffing to only update files that changed.
 
+Alternatively, you can use the bin helper in [async-neocities](https://github.com/bcomnes/async-neocities) to deploy to neocities locally from your own machine as well as in CI.
+
 ## Usage
 
 ```yaml
 name: Deploy to neocities
 
-# only run on changes to master
+# only run on changes to main. Use main or master depending on whatever your default branch is called.
 on:
   push:
     branches:
-      - master
+      - main
 
 concurrency: # prevent concurrent deploys doing strange things
   group: deploy-to-neocities
@@ -30,23 +32,29 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    # The checkout step copies your repo into the action runner. Important!
+    - uses: actions/checkout@v4
     # Set up any tools and build steps here
     # This example uses a Node.js toolchain to build a site
+    # If you don't need Node.js to build your site, you can omit this.
     - name: Use Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: lts/*
+    # If you have a different build process, replace this with your own build steps
     - name: Install deps and build
       run: |
         npm i
         npm run build
     # When the dist_dir is ready, deploy it to neocities
+    # Here we deploy the folder named `public`
     - name: Deploy to neocities
-      uses: bcomnes/deploy-to-neocities@v1
+      uses: bcomnes/deploy-to-neocities@v3
       with:
-        api_token: ${{ secrets.NEOCITIES_API_TOKEN }}
+        api_key: ${{ secrets.NEOCITIES_API_TOKEN }}
         cleanup: false
+        neocities_supporter: false # set this to true if you have a supporter account and want to bypass unsuported files filter.
+        preview_before_deploy: true # print a deployment plan prior to waiting for files to upload.
         dist_dir: public
 ```
 
@@ -61,7 +69,7 @@ You'll need the API token for your site. Go to:
 https://neocities.org/settings/{{your-sitename}}#api_key
 ```
 
-Get your site's API token. In your GitHub repository, set a [secret][sec] called `NEOCITIES_API_TOKEN`.  Set the `api_token` input on your `deploy-to-neocities` action to `${{ secrets.NEOCITIES_API_TOKEN }}` as in the example above.
+Retreive your site's API token from Neocities. In your GitHub repository, set a [secret][sec] called `NEOCITIES_API_TOKEN`.  Set the `api_token` input on your `deploy-to-neocities` action to `${{ secrets.NEOCITIES_API_TOKEN }}` as in the example above. The setting (as of writing) lives in Repository > Settings > Security > Secrets and Variables > Actions > Repository secrets.
 
 During your workflow, generate the files you want to deploy to [Neocities][nc] into a directory. Set this as the `dist_dir` directory in your workflow (the default is `public`).  You can use any tools to generate your site that can be installed or brought into the Github actions environment.
 
@@ -71,9 +79,11 @@ You most likely only want to run this on the `master` branch so that only change
 
 ### Inputs
 
-- `api_token` (**REQUIRED**): The API token for your [Neocities][nc] website to deploy to.
+- `api_key` (**REQUIRED**): The API token for your [Neocities][nc] website to deploy to.
-- `dist_dir`: The directory to deploy to [Neocities][nc]. Default: `public`. Don't deploy your root repo directory (e.g. `./`). It contains `.git`, `.github` and other files that won't deploy properly to neocities. Keep it clean by keeping or building your site into a subdir and deploy that. 
+- `dist_dir`: The directory to deploy to [Neocities][nc]. Default: `public`. Don't deploy your root repo directory (e.g. `./`). It contains `.git`, `.github` and other files that won't deploy properly to neocities. Keep it clean by keeping or building your site into a subdir and deploy that.
+- `neocities_supporter`: Set this to `true` if you have a paid neocities account and want to bypass the [unsupported files filter](https://neocities.org/site_files/allowed_types).
 - `cleanup`:  Boolean string (`true` or `false`).  If `true`, `deploy-to-neocities` will destructively delete files found on [Neocities][nc] not found in your `dist_dir`.  Default: `false`.
+- `preview_before_deploy`: Boolean string (`true` or `false`).  If `true`, `deploy-to-neocities` will print a preview of the files that will be uploaded and deleted.  Default: `true`.
 - `protected_files`: An optional glob string used to mark files as protected.  Protected files are never cleaned up.  Test this option out with `cleanup` set to false before relying on it.  Protected files are printed when `cleanup` is set to true or false.  Glob strings are processed by [minimatch](https://github.com/isaacs/minimatch) against remote neocities file paths.  Protected files can still be updated.
 
 ### Outputs
@@ -142,6 +152,10 @@ None.
 - https://github.com/tencurse/neocities ([10kph.neocities.org](https://10kph.neocities.org/))
 - https://github.com/alephdfilms/neocities/ ([alephd.neocities.org](https://alephd.neocities.org/)]
 - https://sacred.neocities.org/ (https://github.com/M-Valentino/sacredOS)
+- https://lenp.net/ (https://github.com/Len42/web-site)
+- <https://punkfairie.net> (<https://github.com/punkfairie/punkfairie-site>)
+- https://github.com/jefbecker/jefbecker.com ([jefbecker.com](https://jefbecker.com))
+- https://github.com/MymeType/personal-website ([mymetype.neocities.org](https://mymetype.neocities.org/))
 - [See more!](https://github.com/bcomnes/deploy-to-neocities/network/dependents)
 - ...PR your site when you set it up!
 

action.yml

@@ -4,20 +4,32 @@ branding:
   icon: aperture
   color: orange
 inputs:
-  api_token:  # api token for site to deploy to
+  api_key:  # api token for site to deploy to
-    description: 'Neocities API token for site to deploy to'
+    description: 'Neocities API key for site to deploy to'
     required: true
   dist_dir:
     description: 'Local folder to deploy to neocities'
     default: 'public'
     required: true
+  neocities_supporter:
+    description: 'Set to true if you are a Neocities supporter to bypass file type upload restrictions'
+    default: 'false'
+    required: true
   cleanup:
     description: Delete orphaned files on neocities that don't exist in distDir
-    default: false
+    default: 'false'
     required: true
+  preview_before_deploy:
+    description: 'Set to true if you want to print deploy preview stats prior to deploying.'
+    default: 'true'
+    required: false
   protected_files:
     description: A glob string that prevents matched files from ever being deleted.
     required: false
+  api_token:  # api token for site to deploy to
+    description: 'Neocities API key for site to deploy to'
+    required: false
+    deprecationMessage: 'api_token is deprecated, use api_key instead'
 runs:
   using: 'node20'
-  main: 'dist/index.js'
+  main: 'dist/index.cjs'

eslint.config.js

@@ -0,0 +1,8 @@
+import neostandard, { resolveIgnoresFromGitignore } from 'neostandard'
+
+export default neostandard({
+  ignores: [
+    ...resolveIgnoresFromGitignore(),
+    'dist'
+  ],
+})

index.js

@@ -1,57 +1,84 @@
-const core = require('@actions/core')
+import core from '@actions/core'
-// const github = require('@actions/github')
+import {
-const Neocities = require('async-neocities')
+  NeocitiesAPIClient,
-const path = require('path')
+  printDeployText,
-const ms = require('ms')
+  printPreviewText,
-const assert = require('webassert').default
+  printResultsErrorDump,
-const fsp = require('fs').promises
+  SimpleTimer
-const { minimatch } = require('minimatch')
+} from 'async-neocities'
-const { stackWithCauses } = require('pony-cause')
+import path from 'node:path'
+import assert from 'node:assert'
+import fs from 'node:fs/promises'
+import { minimatch } from 'minimatch'
 
-let cleanup
+async function run () {
-
+  const key = core.getInput('api_key') || core.getInput('api_token')
-async function doDeploy () {
-  const token = core.getInput('api_token')
   const distDir = path.join(process.cwd(), core.getInput('dist_dir'))
-  cleanup = JSON.parse(core.getInput('cleanup'))
+  const cleanup = JSON.parse(core.getInput('cleanup'))
+  const neocitiesSupporter = JSON.parse(core.getInput('neocities_supporter'))
+  const previewDeploy = JSON.parse(core.getInput('preview_before_deploy'))
   const protectedFilesGlob = core.getInput('protected_files')
 
-  assert(typeof cleanup === 'boolean', 'Cleanup input must be a boolean "true" or "false"')
+  assert(typeof cleanup === 'boolean', '`cleanup` input must be a boolean "true" or "false"')
-  const stat = await fsp.stat(distDir)
+  assert(typeof neocitiesSupporter === 'boolean', '`neocities_supporter` input must be a boolean "true" or "false"')
-  assert(stat.isDirectory(), 'dist_dir must be a directory that exists')
+  assert(typeof previewDeploy === 'boolean', '`preview_before_deploy` input must be a boolean "true" or "false"')
 
-  const client = new Neocities(token)
+  const stat = await fs.stat(distDir)
 
-  const deployOpts = {
+  assert(stat.isDirectory(), '`dist_dir` input must be a path to a directory that exists')
-    cleanup,
+
-    statsCb: Neocities.statsHandler()
+  const client = new NeocitiesAPIClient(key)
+
+  if (previewDeploy) {
+    const previewTimer = new SimpleTimer()
+    console.log('Running deploy preview prior to deployment...\n\n')
+
+    const diff = await client.previewDeploy({
+      directory: distDir,
+      includeUnsupportedFiles: neocitiesSupporter,
+      protectedFileFilter: protectedFilesGlob ? minimatch.filter(protectedFilesGlob) : undefined
+    })
+
+    previewTimer.stop()
+
+    printPreviewText({
+      diff,
+      timer: previewTimer,
+      cleanup,
+      includeUnsupportedFiles: neocitiesSupporter
+    })
   }
 
-  if (protectedFilesGlob) deployOpts.protectedFileFilter = minimatch.filter(protectedFilesGlob)
+  const deployTimer = new SimpleTimer()
+  console.log('Deploying to Neocities...')
 
-  const stats = await client.deploy(distDir, deployOpts)
+  const results = await client.deploy({
+    directory: distDir,
+    cleanup,
+    includeUnsupportedFiles: neocitiesSupporter,
+    protectedFileFilter: protectedFilesGlob ? minimatch.filter(protectedFilesGlob) : undefined
+  })
 
-  console.log(`Deployed to Neocities in ${ms(stats.time)}:`)
+  deployTimer.stop()
-  console.log(`    Uploaded ${stats.filesToUpload.length} files`)
+
-  console.log(`    ${cleanup ? 'Deleted' : 'Orphaned'} ${stats.filesToDelete.length} files`)
+  if (results.errors.length > 0) {
-  console.log(`    Skipped ${stats.filesSkipped.length} files`)
+    printResultsErrorDump({
-  console.log(`    ${stats.protectedFiles.length} protected files:`)
+      results,
-  if (stats.protectedFiles.length) {
+      timer: deployTimer
-    console.log(stats.protectedFiles)
+    })
+    core.setFailed('The deploy completed with errors.')
+  } else {
+    printDeployText({
+      results,
+      timer: deployTimer,
+      cleanup,
+      includeUnsupportedFiles: neocitiesSupporter
+    })
   }
 }
 
-doDeploy().catch(err => {
+run().catch(err => {
-  console.error(stackWithCauses(err))
+  console.log('Unexpected error/throw during deployment:\n\n')
-  if (err.stats) {
+  console.dir(err, { colors: true, depth: 999 })
-    console.log('Files to upload: ')
+  core.setFailed(err instanceof Error ? err.message : `An unexpected error occurred during deployment: ${err}`)
-    console.dir(err.stats.filesToUpload, { colors: true, depth: 999 })
-
-    if (cleanup) {
-      console.log('Files to delete: ')
-      console.dir(err.stats.filesToDelete, { colors: true, depth: 999 })
-    }
-  }
-
-  core.setFailed(err.message)
 })

package.json

@@ -1,32 +1,32 @@
 {
   "name": "deploy-to-neocities",
   "description": "Github Action to deplpoy a folder to Neocities.org",
-  "version": "2.0.0",
+  "version": "3.0.3",
   "author": "Bret Comnes <bcomnes@gmail.com> (https://bret.io/)",
   "bugs": {
     "url": "https://github.com/bcomnes/deploy-to-neocities/issues"
   },
   "dependencies": {
-    "@actions/core": "1.10.1",
+    "@actions/core": "1.11.1",
-    "async-neocities": "2.1.6",
+    "async-neocities": "4.1.1",
-    "minimatch": "9.0.4",
+    "minimatch": "10.0.1"
-    "ms": "2.1.3",
-    "pony-cause": "^2.1.4",
-    "webassert": "3.0.2"
   },
   "devDependencies": {
-    "top-bun": "^7.0.0",
+    "@voxpelli/tsconfig": "^15.0.0",
+    "top-bun": "^10.0.0",
     "auto-changelog": "^2.0.0",
-    "dependency-check": "^4.1.0",
     "gh-release": "^7.0.0",
-    "npm-run-all2": "^6.0.0",
+    "npm-run-all2": "^8.0.1",
-    "standard": "^17.0.0",
+    "neostandard": "^0.12.0",
-    "esbuild": "^0.20.0"
+    "c8": "^10.0.0",
+    "esbuild": "~0.25.0",
+    "typescript": "~5.8.2"
   },
   "homepage": "https://github.com/bcomnes/deploy-to-neocities#readme",
   "keywords": [],
   "license": "MIT",
   "main": "index.js",
+  "type": "module",
   "private": true,
   "repository": {
     "type": "git",
@@ -34,23 +34,20 @@
   },
   "scripts": {
     "build": "npm run clean && run-p build:*",
-    "build:action": "rm -rf dist && esbuild index.js --bundle --platform=node --target=node16 --sourcemap=external --outdir=dist",
+    "build:action": "rm -rf dist && esbuild index.js --bundle --platform=node --sourcemap=external --outdir=dist --metafile=dist/meta.json --out-extension:.js=.cjs",
-    "build:site": "tb --src . --dest public",
+    "build:site": "tb --src . --dest public --ignore dist,coverage",
+    "dist-pkg": "echo \"{ \\\"type\\\": \\\"commonjs\\\" }\" > dist/package.json",
     "clean": "rm -rf public && mkdir -p public",
     "release": "git push --follow-tags && gh-release -y",
     "start": "npm run watch",
     "test": "run-s test:*",
-    "test:deps": "dependency-check . --no-dev --no-peer",
+    "test:lint": "eslint",
-    "test:standard": "standard",
+    "test:tsc": "tsc",
+    "test:node": "c8 node --test",
     "version": "run-s version:*",
     "version:build": "npm run build:action && git add dist",
     "version:changelog": "auto-changelog -p --template keepachangelog auto-changelog --breaking-pattern 'BREAKING CHANGE:' && git add CHANGELOG.md",
     "watch": "npm run clean && run-p watch:*",
     "watch:site": "npm run build:site -- -w"
-  },
-  "standard": {
-    "ignore": [
-      "dist"
-    ]
   }
 }

test.js

@@ -1,5 +1,6 @@
-const tap = require('tap')
+import assert from 'node:assert'
+import test from 'node:test'
 
-tap.test('test', async t => {
+test('test', async _t => {
-  t.ok(true)
+  assert.ok(true)
 })

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@voxpelli/tsconfig/node20.json",
+  "compilerOptions": {
+    "skipLibCheck": true
+  },
+  "include": [
+    "**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "public",
+    "dist"
+  ]
+}