Create project scaffolding.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+
+dprint-plugin-dockerfile version: x.x.x
+
+**Input Code**
+
+```dockerfile
+```
+
+**Expected Output**
+
+```dockerfile
+```
+
+**Actual Output**
+
+```dockerfile
+```

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,8 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---

.github/ISSUE_TEMPLATE/other.md

@@ -0,0 +1,8 @@
+---
+name: Other
+about: Something that doesn't fall in the other categories
+title: ''
+labels: ''
+assignees: ''
+
+---

.github/workflows/ci.yml

@@ -0,0 +1,146 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: ${{ matrix.config.kind }} ${{ matrix.config.os }}
+    runs-on: ${{ matrix.config.os }}
+    strategy:
+      matrix:
+        config:
+          - os: ubuntu-latest
+            kind: test_release
+          - os: ubuntu-latest
+            kind: test_debug
+
+    env:
+      CARGO_INCREMENTAL: 0
+      RUST_BACKTRACE: full
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install wasm32 target
+      if: matrix.config.kind == 'test_release'
+      run: rustup target add wasm32-unknown-unknown
+
+    - uses: Swatinem/rust-cache@v1
+
+    - name: Build debug
+      if: matrix.config.kind == 'test_debug'
+      run: cargo build --verbose
+    - name: Build release
+      if: matrix.config.kind == 'test_release'
+      run: cargo build --target wasm32-unknown-unknown --features wasm --release --verbose
+
+    - name: Test debug
+      if: matrix.config.kind == 'test_debug'
+      run: cargo test --verbose
+    - name: Test release
+      if: matrix.config.kind == 'test_release'
+      run: cargo test --release --verbose
+
+    - name: Get tag version
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      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: |
+        cd deployment/npm
+        npm install
+        node setup.js ${{ steps.get_tag_version.outputs.TAG_VERSION }}
+        npm run test
+
+    - name: npm publish
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      run: |
+        cd deployment/npm
+        npm publish --access public
+        git reset --hard
+
+      # CARGO PUBLISH
+    - name: Cargo login
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      run: cargo login ${{ secrets.CRATES_TOKEN }}
+
+    - name: Cargo publish
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      run: cargo publish
+
+      # GITHUB RELEASE
+    - name: Pre-release
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      run: |
+        # update config schema to have version
+        sed -i 's/dockerfile-0.0.0.json/dockerfile-${{ steps.get_tag_version.outputs.TAG_VERSION }}.json/' deployment/schema.json
+        # rename the wasm file
+        (cd target/wasm32-unknown-unknown/release/ && mv dprint_plugin_dockerfile.wasm dockerfile.wasm)
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        files: |
+          target/wasm32-unknown-unknown/release/dockerfile.wasm
+          deployment/schema.json
+        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 `.dockerfile` file extensions are matched in an `"includes"` pattern.
+          3. Add a `"dockerfile"` configuration property if desired.
+             ```jsonc
+             {
+               // ...etc...
+               "dockerfile": {
+                 // config goes here
+               },
+               "includes": [
+                 "**/*.{dockerfile}"
+               ],
+               "plugins": [
+                 "https://plugins.dprint.dev/dockerfile-${{ steps.get_tag_version.outputs.TAG_VERSION }}.wasm"
+               ]
+             }
+             ```
+
+          ## JS Formatting API
+
+            * [JS Formatter](https://github.com/dprint/js-formatter) - Browser/Deno and Node
+            * [npm package](https://www.npmjs.com/package/@dprint/dockerfile)
+        draft: false
+
+      # PLUGIN PUBLISH
+    - name: Checkout plugins repo
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      uses: actions/checkout@v2
+      with:
+        repository: dprint/plugins
+        token: ${{ secrets.CI_REPO_PAT }} # github.token is scoped to current repo, so use this to push to other repo
+        path: dprint-plugins
+    - name: Plugin publish
+      if: matrix.config.kind == 'test_release' && startsWith(github.ref, 'refs/tags/')
+      run: |
+          cd dprint-plugins
+          node scripts/replace-plugin.js dprint-plugin-dockerfile ${{ steps.get_tag_version.outputs.TAG_VERSION }} dockerfile-${{ steps.get_tag_version.outputs.TAG_VERSION }}
+          git add .
+          git config user.name "David Sherret"
+          git config user.email "[email protected]"
+          git commit -m "dprint-plugin-dockerfile ${{ steps.get_tag_version.outputs.TAG_VERSION }}"
+          git push origin main

.gitignore

@@ -0,0 +1,4 @@
+/target
+Cargo.lock
+deployment/npm/buffer.generated.js
+deployment/npm/node_modules

Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "dprint-plugin-dockerfile"
+version = "0.0.1"
+authors = ["David Sherret <[email protected]>"]
+edition = "2018"
+homepage = "https://github.com/dprint/dprint-plugin-dockerfile"
+keywords = ["formatting", "formatter", "docker", "dockerfile"]
+license = "MIT"
+repository = "https://github.com/dprint/dprint-plugin-dockerfile"
+description = "A WIP dockerfile formatter for dprint."
+
+[lib]
+crate-type = ["lib", "cdylib"]
+
+[profile.release]
+opt-level = 3
+debug = false
+lto = true
+debug-assertions = false
+overflow-checks = false
+panic = "abort"
+
+[features]
+wasm = ["serde_json", "dprint-core/wasm"]
+tracing = ["dprint-core/tracing"]
+
+[dependencies]
+dockerfile-parser = "0.7.1"
+dprint-core = { version = "0.44.0", features = ["formatting"] }
+serde = { version = "1.0.88", features = ["derive"] }
+serde_json = { version = "1.0", optional = true }
+
+[dev-dependencies]
+dprint-development = "0.4.1"
+serde_json = { version = "1.0" }

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 David Sherret
+
+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.

README.md

@@ -0,0 +1,3 @@
+# dprint-plugin-dockerfile
+
+WIP - Future home of a dockerfile formatter.

deployment/npm/.npmignore

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

deployment/npm/README.md

@@ -0,0 +1,16 @@
+# @dprint/dockerfile
+
+npm distribution of [dprint-plugin-dockerfile](https://github.com/dprint/dprint-plugin-dockerfile).
+
+Use this with [@dprint/formatter](https://github.com/dprint/js-formatter) or just use @dprint/formatter and download the [dprint-plugin-dockerfile WASM file](https://github.com/dprint/dprint-plugin-dockerfile/releases).
+
+## Example
+
+```ts
+import { getBuffer } from "@dprint/dockerfile";
+import { createFromBuffer } from "@dprint/formatter";
+
+const formatter = createFromBuffer(getBuffer());
+
+console.log(formatter.formatText("test.toml", "RUN      /bin/bash"));
+```

deployment/npm/index.d.ts

@@ -0,0 +1,2 @@
+/** Gets a buffer representing the WASM module. */
+export function getBuffer(): ArrayBuffer;

deployment/npm/index.js

@@ -0,0 +1,34 @@
+/**
+ * Gets a buffer representing the WASM module.
+ * @returns {ArrayBuffer}
+ */
+function getBuffer() {
+  const encodedBuffer = require("./buffer.generated").encodedBuffer;
+  return decodeEncodedBuffer(encodedBuffer);
+}
+
+/**
+ * @param {string} encodedBuffer
+ * @returns {ArrayBuffer}
+ */
+function decodeEncodedBuffer(encodedBuffer) {
+  // https://stackoverflow.com/a/51473757/188246
+  const binaryString = toBinaryString();
+  const bytes = new Uint8Array(binaryString.length);
+  for (let i = 0; i < binaryString.length; i++) {
+    bytes[i] = binaryString.charCodeAt(i);
+  }
+  return bytes.buffer;
+
+  function toBinaryString() {
+    if (typeof atob === "function") {
+      return atob(encodedBuffer);
+    } else {
+      return Buffer.from(encodedBuffer, "base64").toString("binary");
+    }
+  }
+}
+
+module.exports = {
+  getBuffer,
+};

deployment/npm/index.test.js

@@ -0,0 +1,9 @@
+// @ts-check
+const assert = require("assert");
+const createFromBuffer = require("@dprint/formatter").createFromBuffer;
+const getBuffer = require("./index").getBuffer;
+
+const formatter = createFromBuffer(getBuffer());
+const result = formatter.formatText("file.dockerfile", "RUN    /bin/bash");
+
+assert.strictEqual(result, "RUN /bin/bash\n");

deployment/npm/package.json

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

deployment/npm/setup.js

@@ -0,0 +1,21 @@
+// @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_dockerfile.wasm");
+const wasmBytes = fs.readFileSync(wasmPath);
+
+let output = "module.exports.encodedBuffer = \"";
+output += wasmBytes.toString("base64");
+output += "\";\n";
+
+fs.writeFileSync(path.join(__dirname, "buffer.generated.js"), output);
+
+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");
+}