feat: initial release (#1)

wkillerud · web-flow · commit 9fd0208a030e · 2025-01-09T12:24:00.000+01:00
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,39 @@
+name: Publish
+
+permissions:
+  contents: write # to be able to publish a GitHub release
+  issues: write # to be able to comment on released issues
+  pull-requests: write # to be able to comment on released pull requests
+  id-token: write # to enable use of OIDC for npm provenance
+
+on:
+  push:
+    branches:
+      - main
+      - alpha
+      - beta
+      - next
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - run: npm install
+
+      - run: npm run lint
+
+      - run: npm run types
+
+      - run: npm test
+
+      - run: npx semantic-release
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,32 @@
+name: Test
+
+on:
+  push:
+    branches-ignore:
+      - main
+      - alpha
+      - beta
+      - next
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        node-version: [22]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: npm install
+
+      - run: npm run lint
+
+      - run: npm run types
+
+      - run: npm test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.DS_Store
+.idea/
+.tap/
+dist/
+node_modules/
+types/
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,2 @@
+package-lock=false
+save-exact=true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Contributing
+
+Thank you for showing an interest in contributing to Eik 🧡
+
+You can find [the contribution docs here](https://github.com/eik-lib/.github/blob/main/CONTRIBUTING.md).
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Eik
+
+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/eslint.config.js b/eslint.config.js
@@ -0,0 +1,8 @@
+import config from "@eik/eslint-config";
+
+export default [
+	...config,
+	{
+		ignores: ["tap-snapshots/*", "node_modules/*", "fixtures/*", "dist/*"],
+	},
+];
diff --git a/fixtures/modules/basic/main.js b/fixtures/modules/basic/main.js
@@ -0,0 +1,6 @@
+import { html } from "lit-element";
+
+const render = (world) => {
+  return html`<p>Hello ${world}!</p>`;
+};
+render();
diff --git a/fixtures/modules/file/main.js b/fixtures/modules/file/main.js
@@ -0,0 +1,19 @@
+import { html } from "lit-html/lit-html";
+import { css } from "lit-html";
+import { LitElement } from "lit-element";
+
+export default class Inner extends LitElement {
+  static get styles() {
+    return [
+      css`
+        :host {
+          color: red;
+        }
+      `,
+    ];
+  }
+
+  render(world) {
+    return html`<p>Hello ${world}!</p>`;
+  }
+}
diff --git a/fixtures/modules/simple/app/app.js b/fixtures/modules/simple/app/app.js
@@ -0,0 +1,21 @@
+import { replaceElement } from "../utils/dom.js";
+import view from "./views.js";
+import data from "../data/data.js";
+
+export default class App {
+  constructor(root) {
+    this.root = root;
+  }
+
+  render() {
+    const items = data();
+    const el = view(items);
+    this.root = replaceElement(this.root, el);
+  }
+
+  update() {
+    setInterval(() => {
+      this.render();
+    }, 1000);
+  }
+}
diff --git a/fixtures/modules/simple/app/views.js b/fixtures/modules/simple/app/views.js
@@ -0,0 +1,5 @@
+import { html } from "lit-element";
+
+export default function view(items) {
+  return html`<p>Hello ${items[0]}!</p>`;
+}
diff --git a/fixtures/modules/simple/data/data.js b/fixtures/modules/simple/data/data.js
@@ -0,0 +1,13 @@
+function random(min, max) {
+  return Math.floor(min + Math.random() * (max + 1 - min));
+}
+
+export default function data() {
+  return [
+    random(0, 20),
+    random(20, 40),
+    random(40, 60),
+    random(60, 80),
+    random(80, 100),
+  ];
+}
diff --git a/fixtures/modules/simple/main.js b/fixtures/modules/simple/main.js
@@ -0,0 +1,19 @@
+import { firstElement } from "./utils/dom.js";
+import App from "./app/app.js";
+
+const ready = () => {
+  return new Promise((resolve) => {
+    document.addEventListener("DOMContentLoaded", () => {
+      const el = document.getElementById("app");
+      resolve(firstElement(el));
+    });
+  });
+};
+
+const start = async () => {
+  const el = await ready();
+  const app = new App(el);
+  app.render();
+  app.update();
+};
+start();
diff --git a/fixtures/modules/simple/utils/dom.js b/fixtures/modules/simple/utils/dom.js
@@ -0,0 +1,8 @@
+export function replaceElement(target, element) {
+  target.replaceWith(element);
+  return element;
+}
+
+export function firstElement(element) {
+  return element.firstElementChild;
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,57 @@
+{
+  "name": "@eik/vite-plugin",
+  "version": "1.0.0",
+  "description": "Vite plugin for loading import maps from a Eik server and applying the mapping to ECMAScript modules in preparation for upload to the same server.",
+  "type": "module",
+  "main": "./src/plugin.js",
+  "types": "./types/plugin.d.ts",
+  "files": [
+    "src",
+    "types"
+  ],
+  "scripts": {
+    "clean": "rimraf node_modules types",
+    "test": "node --test --experimental-test-snapshots",
+    "test:update": "node --test --test-update-snapshots --experimental-test-snapshots",
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "start": "node --experimental-modules ./example/server.mjs",
+    "types": "run-s types:module types:test",
+    "types:module": "tsc",
+    "types:test": "tsc --project tsconfig.test.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/eik-lib/vite-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eik-lib/vite-plugin/issues"
+  },
+  "homepage": "https://github.com/eik-lib/vite-plugin#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "vite-plugin"
+  ],
+  "author": "Finn.no",
+  "license": "MIT",
+  "dependencies": {
+    "@eik/rollup-plugin": "4.0.64"
+  },
+  "devDependencies": {
+    "@eik/eslint-config": "1.0.6",
+    "@eik/prettier-config": "1.0.1",
+    "@eik/semantic-release-config": "1.0.0",
+    "@eik/typescript-config": "1.0.0",
+    "@types/node": "22.10.2",
+    "eslint": "9.17.0",
+    "fastify": "5.2.0",
+    "npm-run-all2": "7.0.2",
+    "prettier": "3.3.3",
+    "rimraf": "6.0.1",
+    "semantic-release": "24.2.0",
+    "typescript": "5.7.2",
+    "vite": "6.0.3"
+  }
+}
diff --git a/prettier.config.js b/prettier.config.js
@@ -0,0 +1,3 @@
+import config from "@eik/prettier-config";
+
+export default config;
diff --git a/release.config.js b/release.config.js
@@ -0,0 +1,3 @@
+export default {
+	extends: "@eik/semantic-release-config",
+};
diff --git a/renovate.json b/renovate.json
@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>eik-lib/renovate-presets:top-level-module"
+  ]
+}
diff --git a/src/plugin.js b/src/plugin.js
@@ -0,0 +1,24 @@
+import rollupPlugin from "@eik/rollup-plugin";
+
+/**
+ * @typedef {import('@eik/rollup-plugin').PluginOptions} EikPluginOptions
+ */
+/**
+ * @typedef {import('@eik/rollup-plugin').ImportMap} EikImportMap
+ */
+
+/**
+ * @param {EikPluginOptions} [options]
+ * @returns {import('vite').Plugin[]}
+ */
+export default function eik(options) {
+	return [
+		{
+			...rollupPlugin(options),
+			enforce: "pre",
+			apply: (_config, { command, isSsrBuild }) =>
+				// only apply plugin for client code, while building
+				command === "build" && !isSsrBuild,
+		},
+	];
+}
diff --git a/test/plugin.test.js b/test/plugin.test.js
diff --git a/test/plugin.test.js.snapshot b/test/plugin.test.js.snapshot
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tsconfig.test.json b/tsconfig.test.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +.DS_Store
 +.idea/
 +.tap/
 +dist/
 +node_modules/
 +types/
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+package-lock=false`
	`2`	`+save-exact=true`