fixdevcontainer 0.1.0 → 0.2.1

package/README.md

@@ -0,0 +1,11 @@
+# fixdevcontainer
+
+Sort top-level keys in devcontainer.json
+
+Inspired by [fixpack](https://www.npmjs.com/package/fixpack)!
+
+## Usage
+
+```shell
+npx fixdevcontainer
+```

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "fixdevcontainer",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "",
-  "main": "fixdevcontainer.js",
+  "main": "main.js",
   "bin": {
-    "fixdevcontainer": "fixdevcontainer.js"
+    "fixdevcontainer": "main.js"
   },
   "keywords": [],
   "author": "",

package/.depcheckrc.json

@@ -1,3 +0,0 @@
-{
-  "ignores": ["jest"]
-}

package/.github/workflows/add-reviewer.yml

@@ -1,15 +0,0 @@
-name: Auto add reviewer
-
-on:
-  pull_request_target:
-    types:
-      - opened
-      - reopened
-    branches:
-      - main
-      - master
-
-jobs:
-  add-reviewer:
-    name: Add reviewer
-    uses: book000/templates/.github/workflows/reusable-add-reviewer.yml@master

package/.github/workflows/nodejs-ci.yml

@@ -1,208 +0,0 @@
-# Node.js でビルド・テストを実行する。バージョンは .node-version に記載されているものを利用する
-
-name: Node CI
-
-on:
-  push:
-    branches:
-      - main
-      - master
-  pull_request:
-    branches:
-      - main
-      - master
-    types:
-      - opened
-      - synchronize
-  pull_request_target:
-    branches:
-      - main
-      - master
-    types:
-      - labeled
-  workflow_dispatch:
-  schedule:
-    - cron: '0 0 * * *'
-
-jobs:
-  node-ci:
-    runs-on: ubuntu-latest
-    if: ${{
-      github.event_name == 'push' ||
-      github.event_name == 'workflow_dispatch' ||
-      github.event_name == 'schedule' ||
-      (github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false) ||
-      (github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.fork == true && contains(github.event.label.name, '🚀request-ci'))
-      }}
-
-    steps:
-      - name: 🛎 Checkout
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: 🏗 Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v2
-        id: pnpm-install
-        with:
-          run_install: false
-
-      - name: 📃 Check package.json definition
-        id: package-json
-        run: |
-          compile=$(jq '.scripts | has("compile")' package.json)
-          build=$(jq '.scripts | has("build")' package.json)
-          generate=$(jq '.scripts | has("generate")' package.json)
-          package=$(jq '.scripts | has("package")' package.json)
-          lint=$(jq '.scripts | has("lint")' package.json)
-          test=$(jq '.scripts | has("test")' package.json)
-
-          echo "compile: $compile"
-          echo "build: $build"
-          echo "generate: $generate"
-          echo "package: $package"
-          echo "lint: $lint"
-          echo "test: $test"
-
-          echo "compile=$compile" >> $GITHUB_OUTPUT
-          echo "build=$build" >> $GITHUB_OUTPUT
-          echo "generate=$generate" >> $GITHUB_OUTPUT
-          echo "package=$package" >> $GITHUB_OUTPUT
-          echo "lint=$lint" >> $GITHUB_OUTPUT
-          echo "test=$test" >> $GITHUB_OUTPUT
-
-      - name: 📂 Get pnpm store directory
-        id: pnpm-cache
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
-
-      - name: 📂 Setup pnpm cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-
-      - name: 👨🏻‍💻 Install dependencies
-        run: |
-          pnpm install --frozen-lockfile --prefer-frozen-lockfile
-
-      - name: 👀 Run linter
-        if: steps.package-json.outputs.lint == 'true'
-        run: pnpm run lint
-
-      - name: 🎁 Run package
-        if: steps.package-json.outputs.package == 'true'
-        run: pnpm run package
-
-      - name: 🏃 Run compile
-        if: steps.package-json.outputs.compile == 'true'
-        run: pnpm run compile
-
-      - name: 🧪 Run tests
-        uses: coactions/setup-xvfb@v1
-        if: steps.package-json.outputs.test == 'true'
-        with:
-          run: pnpm run test
-
-      - name: ☑️ Check Dependencies
-        if: steps.package-json.outputs.disabled-depcheck == 'false'
-        run: npx depcheck
-
-      - name: Check exists dist directory
-        id: check-dist
-        run: |
-          IS_DIRECTORY=$(test -d dist && echo true || echo false)
-          IS_SYMLINK=$(test -L dist && echo true || echo false)
-          echo "exists=$(test $IS_DIRECTORY = true && $IS_NOT_SYMLINK = false && echo true || echo false)" >> $GITHUB_OUTPUT
-
-      - name: 📦 Upload dist artifact
-        if: steps.check-dist.outputs.exists == 'true'
-        uses: actions/upload-artifact@v4
-        with:
-          name: dist
-          path: dist
-
-      - name: Check exists output directory
-        id: check-output
-        run: |
-          IS_DIRECTORY=$(test -d output && echo true || echo false)
-          IS_SYMLINK=$(test -L output && echo true || echo false)
-          echo "exists=$(test $IS_DIRECTORY = true && $IS_NOT_SYMLINK = false && echo true || echo false)" >> $GITHUB_OUTPUT
-
-      - name: 📦 Upload output artifact
-        if: steps.check-output.outputs.exists == 'true'
-        uses: actions/upload-artifact@v4
-        with:
-          name: output
-          path: output
-
-      - name: 👀 Check git status
-        run: |
-          git status
-          git diff --exit-code || (echo "Git status is not clean." && exit 1)
-
-  comment:
-    name: Comment
-    runs-on: ubuntu-latest
-
-    if: ${{
-      github.event_name == 'pull_request_target' &&
-      github.event.action == 'opened' &&
-      github.repository != github.event.pull_request.head.repo.full_name
-      }}
-
-    steps:
-      - name: Create PR comment
-        run: |
-          cat << EOF > comment.md
-          # ⚠️ CIの実行には \`🚀request-ci\` ラベルが必要です
-
-          このリポジトリはフォークされたリポジトリです。
-          セキュリティ上の理由から、フォークされたリポジトリからのCI実行は自動的に行われません。
-
-          CI実行をリクエストするには、このプルリクエストに \`🚀request-ci\` ラベルを追加してください。
-          （ラベルを追加できるのは一部のメンバーのみです）
-          EOF
-
-          gh pr comment ${{ github.event.number }} -R ${{ github.repository }} -F comment.md
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  finished-node-ci:
-    name: Check finished Node CI
-    runs-on: ubuntu-latest
-    if: always()
-    needs:
-      - node-ci
-
-    steps:
-      - name: Workflow conclusion
-        uses: technote-space/workflow-conclusion-action@v3
-
-      - name: Check finished Node CI
-        run: |
-          if [ "${{ env.WORKFLOW_CONCLUSION }}" != "success" ]; then
-            echo "Build failed"
-            exit 1
-          fi
-
-      - name: Remove label
-        if: ${{ github.event_name == 'pull_request_target' && contains(github.event.label.name, '🚀request-ci') }}
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            github.rest.issues.removeLabel({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              name: ['🚀request-ci']
-            })

package/.github/workflows/release.yml

@@ -1,84 +0,0 @@
-name: Release
-
-on:
-  pull_request_target:
-    branches:
-      - main
-      - master
-    types:
-      - closed
-
-concurrency:
-  group: ${{ github.workflow }}
-
-jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    if: github.event.pull_request.merged == true
-
-    steps:
-      - name: 🛎 Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: 🏗 Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v2
-        id: pnpm-install
-        with:
-          run_install: false
-
-      - name: 📂 Get pnpm store directory
-        id: pnpm-cache
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
-
-      - name: 📂 Setup pnpm cache
-        uses: actions/cache@v4
-        with:
-          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-
-      - name: 👨🏻‍💻 Install dependencies
-        run: |
-          pnpm install --frozen-lockfile --prefer-frozen-lockfile
-
-      - name: 🏷 Bump version and push tag
-        id: tag-version
-        uses: mathieudutour/github-tag-action@v6.2
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          default_bump: 'minor'
-          custom_release_rules: 'feat:minor:✨ Features,fix:patch:🐛 Fixes,docs:patch:📰 Docs,chore:patch:🎨 Chore,pref:patch:🎈 Performance improvements,refactor:patch:🧹 Refactoring,build:patch:🔍 Build,ci:patch:🔍 CI,revert:patch:⏪ Revert,style:patch:🧹 Style,test:patch:👀 Test,release:major:📦 Release'
-
-      - name: 📝 Update package.json version
-        run: |
-          pnpm version --no-git-tag-version ${{ steps.tag-version.outputs.new_version }}
-
-      - name: 📦 Publish
-        run: |
-          pnpm publish --access public --no-git-checks
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: 📃 Create Release
-        id: create_release
-        uses: ncipollo/release-action@v1.14.0
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag: ${{ steps.tag-version.outputs.new_tag }}
-          name: ${{ steps.tag-version.outputs.new_tag }}
-          body: ${{ steps.tag-version.outputs.changelog }}
-          draft: false
-          prerelease: false

package/.node-version

@@ -1 +0,0 @@
-20.12.2

package/fixdevcontainer.test.js

@@ -1,264 +0,0 @@
-const fs = require("node:fs");
-const { formatter } = require("./fixdevcontainer");
-
-// Test case 1: Valid JSON input
-const input1 = {
-  name: "My Dev Container",
-  image: "my-dev-container",
-  workspaceFolder: "/workspace",
-  additionalProperties: {
-    prop1: "value1",
-    prop2: "value2",
-  },
-};
-const expectedOutput1 = {
-  $schema: undefined,
-  name: "My Dev Container",
-  image: "my-dev-container",
-  dockerComposeFile: undefined,
-  service: undefined,
-  runServices: undefined,
-  build: undefined,
-  shutdownAction: undefined,
-  overrideCommand: undefined,
-  updateRemoteUserUID: undefined,
-  init: undefined,
-  privileged: undefined,
-  containerUser: undefined,
-  containerEnv: undefined,
-  remoteUser: undefined,
-  remoteEnv: undefined,
-  forwardPorts: undefined,
-  portsAttributes: undefined,
-  otherPortsAttributes: undefined,
-  features: undefined,
-  overrideFeatureInstallOrder: undefined,
-  secrets: undefined,
-  initializeCommand: undefined,
-  onCreateCommand: undefined,
-  updateContentCommand: undefined,
-  postCreateCommand: undefined,
-  postStartCommand: undefined,
-  postAttachCommand: undefined,
-  waitFor: undefined,
-  workspaceFolder: "/workspace",
-  appPort: undefined,
-  runArgs: undefined,
-  workspaceMount: undefined,
-  type: undefined,
-  source: undefined,
-  target: undefined,
-  userEnvProbe: undefined,
-  hostRequirements: undefined,
-  customizations: undefined,
-  additionalProperties: {
-    prop1: "value1",
-    prop2: "value2",
-  },
-};
-
-// Test case 2: JSON input with undefined keys
-const input2 = {
-  name: "My Dev Container",
-  image: "my-dev-container",
-  undefinedKey1: "value1",
-  undefinedKey2: "value2",
-};
-const expectedOutput2 = {
-  $schema: undefined,
-  name: "My Dev Container",
-  image: "my-dev-container",
-  dockerComposeFile: undefined,
-  service: undefined,
-  runServices: undefined,
-  build: undefined,
-  shutdownAction: undefined,
-  overrideCommand: undefined,
-  updateRemoteUserUID: undefined,
-  init: undefined,
-  privileged: undefined,
-  containerUser: undefined,
-  containerEnv: undefined,
-  remoteUser: undefined,
-  remoteEnv: undefined,
-  forwardPorts: undefined,
-  portsAttributes: undefined,
-  otherPortsAttributes: undefined,
-  features: undefined,
-  overrideFeatureInstallOrder: undefined,
-  secrets: undefined,
-  initializeCommand: undefined,
-  onCreateCommand: undefined,
-  updateContentCommand: undefined,
-  postCreateCommand: undefined,
-  postStartCommand: undefined,
-  postAttachCommand: undefined,
-  waitFor: undefined,
-  workspaceFolder: undefined,
-  appPort: undefined,
-  runArgs: undefined,
-  workspaceMount: undefined,
-  type: undefined,
-  source: undefined,
-  target: undefined,
-  userEnvProbe: undefined,
-  hostRequirements: undefined,
-  customizations: undefined,
-  additionalProperties: undefined,
-  undefinedKey1: "value1",
-  undefinedKey2: "value2",
-};
-
-// Test case 3: Empty JSON input
-const input3 = {};
-const expectedOutput3 = {
-  $schema: undefined,
-  name: undefined,
-  image: undefined,
-  dockerComposeFile: undefined,
-  service: undefined,
-  runServices: undefined,
-  build: undefined,
-  shutdownAction: undefined,
-  overrideCommand: undefined,
-  updateRemoteUserUID: undefined,
-  init: undefined,
-  privileged: undefined,
-  containerUser: undefined,
-  containerEnv: undefined,
-  remoteUser: undefined,
-  remoteEnv: undefined,
-  forwardPorts: undefined,
-  portsAttributes: undefined,
-  otherPortsAttributes: undefined,
-  features: undefined,
-  overrideFeatureInstallOrder: undefined,
-  secrets: undefined,
-  initializeCommand: undefined,
-  onCreateCommand: undefined,
-  updateContentCommand: undefined,
-  postCreateCommand: undefined,
-  postStartCommand: undefined,
-  postAttachCommand: undefined,
-  waitFor: undefined,
-  workspaceFolder: undefined,
-  appPort: undefined,
-  runArgs: undefined,
-  workspaceMount: undefined,
-  type: undefined,
-  source: undefined,
-  target: undefined,
-  userEnvProbe: undefined,
-  hostRequirements: undefined,
-  customizations: undefined,
-  additionalProperties: undefined,
-};
-
-// Test case 4: Invalid JSON input
-const input4 = "invalid json";
-const expectedOutput4 = undefined;
-
-// Mock the fs.readFileSync and fs.writeFileSync functions
-jest.mock("node:fs", () => ({
-  existsSync: jest.fn((filename) => {
-    return (
-      filename === "valid.json" ||
-      filename === "undefined_keys.json" ||
-      filename === "empty.json" ||
-      filename === "invalid.json"
-    );
-  }),
-  readFileSync: jest.fn((filename, encoding) => {
-    if (filename === "valid.json") {
-      return JSON.stringify(input1);
-    } else if (filename === "undefined_keys.json") {
-      return JSON.stringify(input2);
-    } else if (filename === "empty.json") {
-      return JSON.stringify(input3);
-    } else if (filename === "invalid.json") {
-      return input4;
-    }
-  }),
-  writeFileSync: jest.fn((filename, data, encoding) => {}),
-}));
-
-// Mock the console.log function
-console.log = jest.fn();
-
-// Mock the console.warn function
-console.warn = jest.fn();
-
-// Mock the console.error function
-console.error = jest.fn();
-
-describe("formatter", () => {
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it("should sort the JSON properties according to the predefined order", () => {
-    const filename = "valid.json";
-    formatter(filename);
-    expect(console.log).toHaveBeenCalledWith(
-      `\u001B[32mSuccessfully sorted and written back to ${filename}\u001B[0m`
-    );
-    expect(fs.writeFileSync).toHaveBeenCalledWith(
-      "valid.json",
-      JSON.stringify(expectedOutput1, null, 2),
-      "utf8"
-    );
-  });
-
-  it("should handle undefined keys by appending them at the end in alphabetical order", () => {
-    formatter("undefined_keys.json");
-    expect(console.warn).toHaveBeenCalledWith(
-      "\u001B[33mWarning: Undefined key 'undefinedKey1' found in JSON\u001B[0m"
-    );
-    expect(console.log).toHaveBeenCalledWith(
-      "\u001B[32mSuccessfully sorted and written back to undefined_keys.json\u001B[0m"
-    );
-    expect(fs.writeFileSync).toHaveBeenCalledWith(
-      "undefined_keys.json",
-      JSON.stringify(expectedOutput2, null, 2),
-      "utf8"
-    );
-  });
-
-  it("should handle empty JSON input", () => {
-    formatter("empty.json");
-    expect(console.log).toHaveBeenCalledWith(
-      "\u001B[32mSuccessfully sorted and written back to empty.json\u001B[0m"
-    );
-    expect(fs.writeFileSync).toHaveBeenCalledWith(
-      "empty.json",
-      JSON.stringify(expectedOutput3, null, 2),
-      "utf8"
-    );
-  });
-
-  it("should handle invalid JSON input", () => {
-    formatter("invalid.json");
-    expect(console.error).toHaveBeenCalledWith(
-      "\u001B[31mError parsing JSON: SyntaxError: Unexpected token 'i', \"invalid json\" is not valid JSON\u001B[0m"
-    );
-    expect(fs.writeFileSync).not.toHaveBeenCalled();
-  });
-
-  it("should handle file read error", () => {
-    formatter("nonexistent.json");
-    expect(console.error).toHaveBeenCalledWith(
-      "\u001B[31mError: File not found: nonexistent.json\u001B[0m"
-    );
-    expect(fs.writeFileSync).not.toHaveBeenCalled();
-  });
-
-  it("should handle file write error", () => {
-    fs.writeFileSync.mockImplementationOnce((filename, data, encoding) => {
-      throw new Error("Write error");
-    });
-    formatter("valid.json");
-    expect(console.error).toHaveBeenCalledWith(
-      "\u001B[31mError writing file: Error: Write error\u001B[0m"
-    );
-  });
-});

package/renovate.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["github>book000/templates//renovate/base-public"]
-}