@magidoc/plugin-starter-variables 0.6.0

package/.eslintrc.cjs

@@ -0,0 +1,9 @@
+const base = require('../../../.eslintrc.cjs')
+
+module.exports = {
+  ...base,
+  parserOptions: {
+    ...base.parserOptions,
+    project: [__dirname + '/tsconfig.json'],
+  },
+}

package/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "type": "node",
+        "name": "vscode-jest-tests",
+        "request": "launch",
+        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+        "args": [
+          "--runInBand"
+        ],
+        "cwd": "${workspaceFolder}",
+        "console": "integratedTerminal",
+        "internalConsoleOptions": "neverOpen",
+        "disableOptimisticBPs": true,
+      }
+    ]
+  }

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Sunny Pelletier
+
+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.

package/build/common/index.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    APP_LOGO: import("../variable").Variable<string>;
+    APP_TITLE: import("../variable").Variable<string>;
+};
+export default _default;

package/build/common/index.js

@@ -0,0 +1,9 @@
+import { createVariable, stringConversion } from '../variable.js';
+
+var index = {
+    APP_LOGO: createVariable('APP_LOGO', stringConversion()),
+    APP_TITLE: createVariable('APP_TITLE', stringConversion()),
+};
+
+export { index as default };
+//# sourceMappingURL=index.js.map

package/build/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/common/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA,YAAe;AACb,IAAA,QAAQ,EAAE,cAAc,CAAS,UAAU,EAAE,gBAAgB,EAAE,CAAC;AAChE,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACnE;;;;"}

package/build/index.d.ts

@@ -0,0 +1,2 @@
+import common from './common';
+export { common };

package/build/index.js

@@ -0,0 +1,2 @@
+export { default as common } from './common/index.js';
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/build/variable.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copy of the ViteJS import meta interface
+ */
+interface MetaEnv {
+    [key: string]: unknown;
+}
+export declare type Variable<T> = {
+    vite: ViteVariable<T>;
+};
+export declare type ViteVariable<T> = {
+    key: string;
+    get: (env: MetaEnv) => T | null;
+    getOrDefault: (env: MetaEnv, def: T) => T;
+};
+export declare function createVariable<T = string | boolean>(key: string, conversion: (target: unknown) => T): Variable<T>;
+export declare function stringConversion(): (target: unknown) => string;
+export declare function booleanConversion(): (target: unknown) => boolean;
+export {};

package/build/variable.js

@@ -0,0 +1,17 @@
+function createVariable(key, conversion) {
+    const viteKey = `VITE_${key.toUpperCase()}`;
+    const viteGet = (env) => env[viteKey] !== undefined ? conversion(env[viteKey]) : null;
+    return {
+        vite: {
+            key: viteKey,
+            get: viteGet,
+            getOrDefault: (env, def) => viteGet(env) ?? def,
+        },
+    };
+}
+function stringConversion() {
+    return (target) => String(target);
+}
+
+export { createVariable, stringConversion };
+//# sourceMappingURL=variable.js.map

package/build/variable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable.js","sources":["../../src/variable.ts"],"sourcesContent":[null],"names":[],"mappings":"AAiBgB,SAAA,cAAc,CAC5B,GAAW,EACX,UAAkC,EAAA;IAElC,MAAM,OAAO,GAAG,CAAQ,KAAA,EAAA,GAAG,CAAC,WAAW,EAAE,EAAE,CAAA;IAC3C,MAAM,OAAO,GAAG,CAAC,GAAY,KAC3B,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAA;IAE9D,OAAO;AACL,QAAA,IAAI,EAAE;AACJ,YAAA,GAAG,EAAE,OAAO;AACZ,YAAA,GAAG,EAAE,OAAO;AACZ,YAAA,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG;AAChD,SAAA;KACF,CAAA;AACH,CAAC;SAEe,gBAAgB,GAAA;IAC9B,OAAO,CAAC,MAAe,KAAa,MAAM,CAAC,MAAM,CAAC,CAAA;AACpD;;;;"}

package/jest.config.cjs

@@ -0,0 +1,11 @@
+const base = require('../../../jest.config.cjs')
+
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  ...base,
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.json',
+    },
+  }
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@magidoc/plugin-starter-variables",
+  "description": "A shared library that contains common Magidoc starter environment variables keys.",
+  "private": false,
+  "version": "0.6.0",
+  "type": "module",
+  "license": "MIT",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "keywords": [
+    "node",
+    "magidoc"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^8.3.2",
+    "@types/jest": "^27.4.1",
+    "jest": "^27.5.1",
+    "rollup": "^2.70.2",
+    "ts-jest": "^27.1.4",
+    "tslib": "^2.3.1",
+    "typescript": "^4.6.3"
+  },
+  "scripts": {
+    "start": "pnpm build:rollup && node build/index.js",
+    "build": "run-p build:*",
+    "build:rollup": "rollup -c",
+    "build:tsc": "tsc --build tsconfig.build.json",
+    "test": "jest",
+    "release": "pnpm publish --no-git-checks --access public"
+  },
+  "readme": "# Magidoc Starters Variables\nThis is an internal Magidoc shared library used for starters environment variables. You most likely never will need to use this library directly. \n"
+}

package/readme.md

@@ -0,0 +1,2 @@
+# Magidoc Starters Variables
+This is an internal Magidoc shared library used for starters environment variables. You most likely never will need to use this library directly. 

package/rollup.config.cjs

@@ -0,0 +1,14 @@
+const { defineConfig } = require('rollup')
+const typescript = require('@rollup/plugin-typescript')
+const shebang = require('rollup-plugin-preserve-shebang')
+
+module.exports = defineConfig({
+  input: ['src/index.ts'],
+  plugins: [typescript()],
+  output: {
+    dir: 'build',
+    format: 'esm',
+    sourcemap: true,
+    preserveModules: true,
+  },
+})

package/src/common/index.ts

@@ -0,0 +1,6 @@
+import { createVariable, stringConversion } from '../variable'
+
+export default {
+  APP_LOGO: createVariable<string>('APP_LOGO', stringConversion()),
+  APP_TITLE: createVariable<string>('APP_TITLE', stringConversion()),
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+import common from './common'
+
+export { common }

package/src/variable.ts

@@ -0,0 +1,53 @@
+/**
+ * Copy of the ViteJS import meta interface
+ */
+interface MetaEnv {
+  [key: string]: unknown
+}
+
+export type Variable<T> = {
+  vite: ViteVariable<T>
+}
+
+export type ViteVariable<T> = {
+  key: string
+  get: (env: MetaEnv) => T | null
+  getOrDefault: (env: MetaEnv, def: T) => T
+}
+
+export function createVariable<T = string | boolean>(
+  key: string,
+  conversion: (target: unknown) => T,
+): Variable<T> {
+  const viteKey = `VITE_${key.toUpperCase()}`
+  const viteGet = (env: MetaEnv) =>
+    env[viteKey] !== undefined ? conversion(env[viteKey]) : null
+
+  return {
+    vite: {
+      key: viteKey,
+      get: viteGet,
+      getOrDefault: (env, def) => viteGet(env) ?? def,
+    },
+  }
+}
+
+export function stringConversion() {
+  return (target: unknown): string => String(target)
+}
+
+export function booleanConversion() {
+  return (target: unknown): boolean => {
+    switch (typeof target) {
+      case 'boolean':
+        return target
+      case 'string':
+        const lowerCase = target.toLowerCase().trim()
+        return lowerCase === 'true' || lowerCase === 't' || lowerCase === '1'
+      case 'number':
+        return target !== 0
+      default:
+        return !!target
+    }
+  }
+}

package/tests/index.spec.ts

@@ -0,0 +1,31 @@
+import * as variables from '../src/index'
+import type { Variable } from '../src/variable'
+
+describe('variables', () => {
+  it('contains the right number of export keys', () => {
+    expect(Object.keys(variables)).toEqual(['common'])
+  })
+
+  it('contains the right common variables', () => {
+    expect(Object.keys(variables.common)).toEqual(['APP_LOGO', 'APP_TITLE'])
+
+    testStringVariable(variables.common.APP_TITLE, 'VITE_APP_TITLE')
+    testStringVariable(variables.common.APP_LOGO, 'VITE_APP_LOGO')
+  })
+})
+
+function testStringVariable(target: Variable<string>, viteKey: string) {
+  expect(target.vite.key).toEqual(viteKey)
+
+  expect(target.vite.get({ [viteKey]: 'Potato' })).toBe('Potato')
+  expect(target.vite.get({ [viteKey]: false })).toBe('false')
+  expect(target.vite.get({})).toBeNull()
+
+  expect(target.vite.getOrDefault({ [viteKey]: 'Potato' }, 'Default')).toBe(
+    'Potato',
+  )
+  expect(target.vite.getOrDefault({ [viteKey]: false }, 'Default')).toBe(
+    'false',
+  )
+  expect(target.vite.getOrDefault({}, 'Default')).toBe('Default')
+}

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "build"
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "useDefineForClassFields": true,
+    "importsNotUsedAsValues": "error",
+    "isolatedModules": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "strict": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "sourceMap": true,
+    "outDir": "build",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "lib": ["esnext", "dom"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "tests/**/*.ts"],
+  "exclude": ["build", "node_modules"]
+}