first release

riccardodallavia · riccardodallavia · commit 56696c9dde1c · 2022-10-24T13:06:28.000+02:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: maize-tech
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/maize-tech/laravel-mix-static-cache-busting/discussions/new?category=q-a
+    about: Ask the community for help
+  - name: Request a feature
+    url: https://github.com/maize-tech/laravel-mix-static-cache-busting/discussions/new?category=ideas
+    about: Share ideas for new features
+  - name: Report a security issue
+    url: https://github.com/maize-tech/laravel-mix-static-cache-busting/security/policy
+    about: Learn how to notify us for sensitive bugs
+  - name: Report a bug
+    url: https://github.com/maize-tech/laravel-mix-static-cache-busting/issues/new
+    about: Report a reproducible bug
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -0,0 +1,3 @@
+# Security Policy
+
+If you discover any security related issues, please email inn.security@h-farm.com instead of using the issue tracker.
diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml
@@ -0,0 +1,28 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+node_modules
+npm-debug.log
+.DS_Store
+.idea
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to `laravel-mix-static-cache-busting` will be documented in this file.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 MAIZE SRL <innovation@h-farm.com>
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,96 @@
+# Laravel Mix Static Cache Busting
+
+<a href="https://www.npmjs.com/package/@maize-tech/laravel-mix-static-cache-busting"><img src="https://img.shields.io/npm/v/@maize-tech/laravel-mix-static-cache-busting.svg" alt="NPM"></a>
+<a href="https://npmcharts.com/compare/@maize-tech/laravel-mix-static-cache-busting?minimal=true"><img src="https://img.shields.io/npm/dt/@maize-tech/laravel-mix-static-cache-busting.svg" alt="NPM"></a>
+<a href="https://www.npmjs.com/package/@maize-tech/laravel-mix-static-cache-busting"><img src="https://img.shields.io/npm/l/@maize-tech/laravel-mix-static-cache-busting.svg" alt="NPM"></a>
+
+This package allows you to simulate Laravel `mix` function, used for cache busting, without the need to use PHP in your project.
+
+The plugin will grab your static `index.html` file, search for any asset and replace them with all occurrences specified within `mix-manifest.json`.
+
+For example, if your `index.html` file includes this stylesheet reference:
+
+```html
+<link rel="stylesheet" type="text/css" href="/app.css">
+```
+
+the plugin will automatically replace it during the compilation with:
+
+```html
+<link rel="stylesheet" type="text/css" href="/app.css?id=fbd7c81ea490324c303c">
+```
+
+### Installation
+
+You can install this package via npm:
+
+```bash
+npm i @maize-tech/laravel-mix-static-cache-busting --save-dev
+```
+
+### Usage
+
+To use the package, all you need to do is update your `webpack.mix.js` file and add the `staticCacheBusting` method.
+The first parameter is the `mix-manifest.json` file path, while the second one is the `index.html` file path.
+
+Here's an example implementation of the method:
+
+```js
+let mix = require('laravel-mix');
+
+require('laravel-mix-static-cache-busting');
+
+mix
+  // tasks that will generate a mix-manifest.json
+  .staticCacheBusting('./dist/mix-manifest.json', './dist/index.html') // change paths at your discretion
+```
+
+### Troubleshooting
+
+The plugin isn't working?
+Check the entry attributes in your `mix-manifest.json` and make sure your html `href` attributes follow the same path.
+
+For example, if your `mix-manifest.json` file has this attribute for the `app.css` file:
+
+```json
+{
+    "/app.css": "/app.css?id=fbd7c81ea490324c303c"
+}
+```
+
+then your `index.html` should reference the file this way:
+
+```html
+<!-- note the slash before app.css -->
+<link rel="stylesheet" type="text/css" href="/app.css">
+```
+
+while this will **not** work:
+
+```html
+<!-- initial slash missing! -->
+<link rel="stylesheet" type="text/css" href="app.css">
+```
+
+Also, please note that this plugin will replace any entry as-is and anywhere it's placed within the targeted file (index.html).
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
+
+## Security Vulnerabilities
+
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+
+## Credits
+
+- [Francesco Zaniol](https://github.com/francescozaniol)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
diff --git a/package.json b/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "@maize-tech/laravel-mix-static-cache-busting",
+  "version": "1.0.0",
+  "description": "A replacement for Laravel Mix's \"mix\" function, used for cache busting",
+  "main": "src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/maize-tech/laravel-mix-static-cache-busting.git"
+  },
+  "keywords": [
+    "laravel",
+    "mix",
+    "cache"
+  ],
+  "author": "H-FARM Innovation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/maize-tech/laravel-mix-static-cache-busting/issues"
+  },
+  "homepage": "https://github.com/maize-tech/laravel-mix-static-cache-busting#readme",
+  "peerDependencies": {
+    "laravel-mix": "^5.0.1"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,35 @@
+let mix = require('laravel-mix');
+const Task = require('laravel-mix/src/tasks/Task');
+const fs = require('fs');
+const path = require('path');
+
+class StaticCacheBustingTask extends Task {
+
+  async mainTask() {
+    const mixManifest = JSON.parse(
+      await fs.promises.readFile(path.resolve(this.data.mixManifest), 'utf8')
+    );
+    let index = await fs.promises.readFile(path.resolve(this.data.index), 'utf8');
+    for (const asset in mixManifest) {
+      index = index.replace(asset, mixManifest[asset]);
+    }
+    await fs.promises.writeFile(path.resolve(this.data.index), index);
+  }
+
+  run() {
+    this.mainTask();
+  }
+
+  watch() {
+    this.mainTask();
+  }
+
+}
+
+class StaticCacheBusting {
+  register(mixManifest, index) {
+    Mix.addTask(new StaticCacheBustingTask({mixManifest, index}));
+  }
+}
+
+mix.extend('staticCacheBusting', new StaticCacheBusting());

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Security Policy`
	`2`	`+`
	`3`	`+If you discover any security related issues, please email inn.security@h-farm.com instead of using the issue tracker.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Changelog`
	`2`	`+`
	`3`	+All notable changes to `laravel-mix-static-cache-busting` will be documented in this file.