diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index be0ca565..00000000 --- a/.eslintrc.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = { - root: true, - env: { - node: true, - }, - parser: "@typescript-eslint/parser", - plugins: ["@typescript-eslint"], - extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"], -}; diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 8844bef5..afba28f3 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -12,14 +12,14 @@ jobs: strategy: matrix: - node-version: [14.x, 16.x, 18.x] + node-version: [18.x, 20.x, 22.x] steps: - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} diff --git a/README.md b/README.md index ba33dac0..a3054b4e 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,389 @@ [Vite](https://vitejs.dev) is a modern frontend build tool that provides an extremely fast development environment and bundles your code for production. -This plugin configures Vite for use with a [ColdBox](https://www.coldbox.org/) backend server. +This plugin integrates Vite with a [ColdBox](https://www.coldbox.org/) backend, handling: -## Official Documentation +- Dev-server URL injection so ColdBox can load hot-module-replacement assets. +- Asset manifest generation for cache-busted production builds. +- Full-page reload when ColdBox views, layouts, or routes change. +- Support for both the **flat** (traditional CFML/ColdBox) and **BoxLang / tiered** application layouts. -TODO: Write gitbook and link it here. +The CFML/BoxLang side of the integration is provided by the [**coldbox-vite** ColdBox module](https://www.forgebox.io/view/coldbox-vite), which reads the dev-server URL from the hot file and renders the appropriate `