iceforge-asis 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Caitlin Salt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# iceforge-asis
+"As-is" plugin for the [Iceforge](https://github.com/caitlinsalt/iceforge) static site generator.
+
+In operation, Iceforge processes files whose extensions (or names in general) match patterns it knows about, and passes other files through unchanged.
+
+However, out of the box, Iceforge installs handlers for JSON and Markdown files which render them through templates, making it impossible for your site to deliver a file named `example.json` or `something.md`.
+
+Enter `iceforge-asis`.  It lets you pass files through unchanged, aside from removing `.asis` from the filename.
+
+## Usage
+
+1. In your Iceforge site, install iceforge-asis with `npm i iceforge-asis`.
+2. In your site `config.json`, add `iceforge-asis` to the plugins section.
+3. Rename the JSON or MD files you need to deliver unchanged, by adding `.asis` to the extension.  For example, `example.json` becomes `example.json.asis`
+
+Iceforge's build process will rename the file back to `example.json`, but will not process the file itself.
+
+iceforge-asis is based on the [wintersmith-asis](https://github.com/luckyrandom/wintersmith-asis) plugin for the [Wintersmith](https://wintersmith.io/) static site generator, written by Chenliang Xu.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { FilePath, IEnvironment, StaticFile } from 'iceforge';
+export declare class AsisFile extends StaticFile {
+    constructor(filepath: FilePath);
+    get name(): string;
+    get filename(): string;
+    get pluginColour(): string;
+    static fromFile(filepath: FilePath): Promise<AsisFile>;
+}
+declare const registerPlugin: (env: IEnvironment) => Promise<void>;
+export default registerPlugin;

package/dist/index.js

@@ -0,0 +1,26 @@
+import { StaticFile } from 'iceforge';
+export class AsisFile extends StaticFile {
+    constructor(filepath) {
+        super(filepath);
+    }
+    get name() {
+        return 'AsisFile';
+    }
+    get filename() {
+        let rv = super.filename;
+        rv = rv.replace(/\.asis$/, '');
+        rv = rv.replace(/(^|\/)_asis_\.(?=[^/]*$)/, '/');
+        return rv;
+    }
+    get pluginColour() {
+        return 'blue';
+    }
+    static async fromFile(filepath) {
+        return new AsisFile(filepath);
+    }
+}
+const registerPlugin = async (env) => {
+    env.registerContentPlugin('asis', '**/*.asis', AsisFile);
+    env.registerContentPlugin('asis', '**/_asis_.*', AsisFile);
+};
+export default registerPlugin;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "iceforge-asis",
+  "version": "1.0.0",
+  "description": "As-is plugin for the Iceforge static site generator",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "prepack": "tsc",
+    "lint": "eslint --ext .js,.ts --ignore-path .eslintignore",
+    "test": "vitest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/caitlinsalt/iceforge-asis.git"
+  },
+  "author": "Caitlin Salt",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/caitlinsalt/iceforge-asis/issues"
+  },
+  "homepage": "https://github.com/caitlinsalt/iceforge-asis#readme",
+  "dependencies": {
+    "iceforge": "^1.0.2"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^7.13.1",
+    "@typescript-eslint/parser": "^7.13.1",
+    "eslint": "^8.57.0",
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0",
+    "winston": "^3.13.0"
+  }
+}