Add wesnoth-map-diff

.github/workflows/map-diff.yml

@@ -0,0 +1,82 @@
+name: Map Diff
+
+on:
+  pull_request:
+    paths:
+    - '**.map'
+
+jobs:
+  comment-map-diff:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v3.0.0
+    - uses: actions/setup-node@v3.0.0
+      with:
+        node-version: '16'
+    - name: Package install
+      run: |
+        cd ./utils/wesnoth-map-diff
+        npm install
+    - name: Package build
+      run: |
+        cd ./utils/wesnoth-map-diff
+        npm run build:prod
+    - name: Get maps diff
+      id: get-maps-diff
+      run: |
+        cd ./utils/wesnoth-map-diff
+
+        ## Get Maps
+        git fetch --depth=1 origin ${{ github.event.pull_request.base.sha }}
+
+        map_paths=($(git diff --name-only HEAD ${{ github.event.pull_request.base.sha }} | grep ".map$"))
+
+        for map_path in "${map_paths[@]}"
+        do
+          map_filename=$(basename "$map_path")
+          git show ${{ github.event.pull_request.base.sha }}:$map_path > $map_filename
+        done
+
+        ## Run map diff
+        diff_images=()
+
+        for map_path in "${map_paths[@]}"
+        do
+          map_filename=$(basename "$map_path")
+          output_filename=$(echo "$map_filename" | perl -pe 's/map$/png/')
+
+          node ./build/index.js "./$map_filename" "../../$map_path" "./$output_filename"
+
+          diff_images+=("$output_filename")
+        done
+
+        ## Compress images
+        sudo apt-get install -y pngquant
+
+        for diff_image in "${diff_images[@]}"
+        do
+          pngquant "$diff_image" -o "$diff_image" --force
+        done
+
+        ## Write comment body
+        comment_body=""
+
+        for i in "${!diff_images[@]}"
+        do
+          map_path=${map_paths[$i]}
+          diff_image=${diff_images[$i]}
+
+          image_link=$(curl -X POST "https://api.imgur.com/3/upload" \
+            -F "image=@\"$diff_image\"" | jq ".data.link" -r)
+
+          comment_body="$comment_body<h3>$map_path</h3><img src=\"$image_link\" /><br />"
+        done
+
+        echo "::set-output name=COMMENT_BODY::$comment_body"
+    - name: Add comment
+      uses: peter-evans/create-or-update-comment@v1.4.5
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        edit-mode: replace
+        body: |
+          ${{ steps.get-maps-diff.outputs.COMMENT_BODY }}

utils/wesnoth-map-diff/.eslintignore

@@ -0,0 +1 @@
+build

utils/wesnoth-map-diff/.eslintrc.js

@@ -0,0 +1,81 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  overrides: [
+    {
+      files: ['**/*.ts'],
+    },
+  ],
+  extends: [
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  rules: {
+    '@typescript-eslint/member-delimiter-style': ['error', {
+      multiline: {
+        delimiter: 'comma',
+        requireLast: true,
+      },
+      singleline: {
+        delimiter: 'comma',
+        requireLast: false,
+      },
+    }],
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-empty-interface': [
+      'error',
+      {
+        allowSingleExtends: true,
+      },
+    ],
+    '@typescript-eslint/no-var-requires': 'off',
+    'arrow-parens': 'off',
+    'comma-dangle': [
+      'error',
+      {
+        arrays: 'always-multiline',
+        exports: 'always-multiline',
+        functions: 'never',
+        imports: 'always-multiline',
+        objects: 'always-multiline',
+      },
+    ],
+    'function-paren-newline': ['error', 'consistent'],
+    'quote-props': ['error', 'as-needed'],
+    'max-len': [
+      'error',
+      {
+        code: 120,
+        ignoreComments: true,
+        ignoreRegExpLiterals: true,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true,
+        ignoreTrailingComments: true,
+        ignoreUrls: true,
+        tabWidth: 2,
+      },
+    ],
+    'multiline-ternary': ['error', 'always-multiline'],
+    'no-unused-expressions': ['error', { allowTernary: true }],
+    'no-multiple-empty-lines': [
+      'error',
+      {
+        max: 1,
+        maxEOF: 1,
+      },
+    ],
+    'implicit-arrow-linebreak': 'off',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    semi: ['error', 'never'],
+    'space-before-function-paren': ['error', 'always'],
+    'object-curly-spacing': ['error', 'always'],
+    'operator-linebreak': [
+      'error',
+      'before',
+      { overrides: { '=': 'after', ':': 'before', '?': 'before' } },
+    ],
+  },
+}

utils/wesnoth-map-diff/.gitignore

@@ -0,0 +1,4 @@
+.eslintcache
+
+node_modules/
+build/

utils/wesnoth-map-diff/README.md

@@ -0,0 +1,39 @@
+# wesnoth-map-diff
+
+> 🗺 Print the diff between two maps
+
+## Setup
+
+1 - Make sure you have Node on your system. If you don't have it, install it. If you are using macOS or Linux, you can install Node using [nvm](https://github.com/nvm-sh/nvm). On Windows, use [nvm-windows](https://github.com/coreybutler/nvm-windows).
+
+2 - Open the terminal on `utils/wesnoth-map-diff` folder and run the following command to install the project dependencies:
+
+```
+npm i
+```
+
+3 - Then, run the following command to build it:
+
+```
+npm run build:dev
+```
+
+4 - Finally, run it using `node ./build/index.js [path for the old map] [path for the new map] [output filename]`. For instance:
+
+```
+node ./build/index.js old.map new.map output.png
+```
+
+## Contributing
+
+Run tests:
+
+```
+npm run test
+```
+
+Run lint:
+
+```
+npm run lint
+```

utils/wesnoth-map-diff/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+}

utils/wesnoth-map-diff/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  setupFilesAfterEnv: ['./setup-jest.js'],
+}