feat: publish on npm (#16)

Co-authored-by: so1ve <i@mk1.io>

Author: disrupted

.github/workflows/ci.yml

@@ -1,6 +1,4 @@
 name: CI
-# taken from main dprint plugins
-# without npm for now
 
 on: [push, pull_request]
 
@@ -50,6 +48,30 @@ jobs:
         id: get_tag_version
         run: echo ::set-output name=TAG_VERSION::"${GITHUB_REF/refs\/tags\//}"
 
+      # NPM
+      - uses: actions/setup-node@v2
+        if: matrix.config.kind == 'test_release'
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Setup and test npm deployment
+        if: matrix.config.kind == 'test_release'
+        run: |
+          npm install
+          node setup.js ${{ steps.get_tag_version.outputs.TAG_VERSION }}
+          npm run test
+        working-directory: ./deployment/npm
+
+      - name: npm publish
+        if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm publish --access public
+          git reset --hard
+        working-directory: ./deployment/npm
+
         # CARGO PUBLISH
       - name: Cargo login
         if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
@@ -64,7 +86,7 @@ jobs:
         if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
         run: |
           # update config schema to have version
-          sed -i 's/0.0.0/${{ steps.get_tag_version.outputs.TAG_VERSION }}/' deployment/schema.json
+          sed -i 's/css\/0.0.0/css\/${{ steps.get_tag_version.outputs.TAG_VERSION }}/' deployment/schema.json
           # rename the wasm file
           (cd target/wasm32-unknown-unknown/release/ && mv dprint_plugin_css.wasm plugin.wasm)
       - name: Release
@@ -76,5 +98,33 @@ jobs:
           files: |
             target/wasm32-unknown-unknown/release/plugin.wasm
             deployment/schema.json
-          body: ""
+          body: |
+            ## Install
+
+            [Install](https://dprint.dev/install/) and [setup](https://dprint.dev/setup/) dprint.
+
+            Then in your project's dprint configuration file:
+
+            1. Specify the plugin url in the `"plugins"` array.
+            2. Ensure `.css` file extensions are matched in an `"includes"` pattern.
+            3. Add a `"css"` configuration property if desired.
+              ```jsonc
+              {
+                // ...etc...
+                "css": {
+                  // css config goes here
+                },
+                "includes": [
+                  "**/*.{css}"
+                ],
+                "plugins": [
+                  "https://github.com/disrupted/dprint-plugin-css/raw/${{ steps.get_tag_version.outputs.TAG_VERSION }}/deployment/npm/plugin.wasm"
+                ]
+              }
+              ```
+
+            ## JS Formatting API
+
+              * [JS Formatter](https://github.com/dprint/js-formatter) - Browser/Deno and Node
+              * [npm package](https://www.npmjs.com/package/dprint-plugin-css)
           draft: false

.gitignore

@@ -1 +1,3 @@
 /target
+deployment/npm/node_modules
+deployment/npm/plugin.wasm

deployment/npm/.npmignore

@@ -0,0 +1,2 @@
+setup.js
+index.test.js

deployment/npm/README.md

@@ -0,0 +1,18 @@
+# dprint-plugin-css
+
+npm distribution of [dprint-plugin-css](https://github.com/disrupted/dprint-plugin-css).
+
+Use this with [@dprint/formatter](https://github.com/dprint/js-formatter) or just use @dprint/formatter and download the [dprint-plugin-json WASM file](https://github.com/disrupted/dprint-plugin-css/releases).
+
+## Example
+
+```ts
+import { createFromBuffer } from "@dprint/formatter";
+import { getPath } from "dprint-plugin-css";
+import * as fs from "fs";
+
+const buffer = fs.readFileSync(getPath());
+const formatter = createFromBuffer(buffer);
+
+console.log(formatter.formatText("test.css", ".test{color: red}"));
+```

deployment/npm/index.d.ts

@@ -0,0 +1,2 @@
+/** Gets an absolute path to the Wasm module. */
+export function getPath(): string;

deployment/npm/index.js

@@ -0,0 +1,11 @@
+/**
+ * Gets the path to the Wasm module.
+ * @returns {string}
+ */
+function getPath() {
+  return require("path").join(__dirname, "plugin.wasm");
+}
+
+module.exports = {
+  getPath,
+};

deployment/npm/index.test.js

@@ -0,0 +1,10 @@
+// @ts-check
+const assert = require("assert");
+const createFromBuffer = require("@dprint/formatter").createFromBuffer;
+const getPath = require("./index").getPath;
+
+const buffer = require("fs").readFileSync(getPath());
+const formatter = createFromBuffer(buffer);
+const result = formatter.formatText("file.json", ".test{color: red}");
+
+assert.strictEqual(result, ".test {\n    color: red;\n}\n");

deployment/npm/package-lock.json

@@ -0,0 +1,29 @@
+{
+  "name": "dprint-plugin-css",
+  "version": "0.0.0",
+  "description": "Wasm module for dprint-plugin-css.",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/disrupted/dprint-plugin-css.git"
+  },
+  "keywords": [
+    "css",
+    "code",
+    "formatter",
+    "dprint"
+  ],
+  "author": "Salomon Popp",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/disrupted/dprint-plugin-css/issues"
+  },
+  "homepage": "https://github.com/disrupted/dprint-plugin-css#readme",
+  "scripts": {
+    "test": "node index.test.js"
+  },
+  "devDependencies": {
+    "@dprint/formatter": "~0.1.4"
+  }
+}

deployment/npm/package.json

@@ -0,0 +1,15 @@
+// @ts-check
+const fs = require("fs");
+const path = require("path");
+const args = process.argv.slice(2);
+const wasmPath = path.join(__dirname, "../../target/wasm32-unknown-unknown/release/dprint_plugin_css.wasm");
+fs.copyFileSync(wasmPath, path.join(__dirname, "plugin.wasm"));
+
+if (args.length > 0) {
+  // update the version based on the first argument
+  const packageJsonPath = path.join(__dirname, "package.json");
+  const packageJsonText = fs.readFileSync(packageJsonPath, "utf8");
+  const packageJson = JSON.parse(packageJsonText);
+  packageJson.version = args[0];
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, undefined, 2) + "\n");
+}