@mnaoumov/create-obsidian-plugin 0.0.0-stage → 1.0.1

package/templates/default/src/wasm.d.ts_parcel.ejs

@@ -0,0 +1,7 @@
+// Parcel resolves a plain `.wasm` import to its own output bundle -- a second file beside `main.js`,
+// Which an Obsidian release does not ship. Parcel's `data-url:` scheme inlines the file instead, so the
+// Module travels inside the bundle as a `data:` URL.
+declare module 'data-url:*' {
+  const dataUrl: string;
+  export default dataUrl;
+}

package/templates/default/src/wasm.d.ts_rollup.ejs

@@ -0,0 +1,8 @@
+// `@rollup/plugin-wasm` turns a `.wasm` import into a LOADER FUNCTION: call it and it decodes the
+// Inlined base64 and instantiates the module. Passing an imports object -- even an empty one -- is what
+// Makes it resolve to `{ module, instance }`; called with nothing it resolves to a bare
+// `WebAssembly.Module` instead, which has no `exports` to read.
+declare module '*.wasm' {
+  const load: (imports: WebAssembly.Imports) => Promise<WebAssembly.WebAssemblyInstantiatedSource>;
+  export default load;
+}

package/templates/default/src/wasm.d.ts_vite.ejs

@@ -0,0 +1,8 @@
+// Vite's WebAssembly plugin (`vite-plugin-wasm`) implements the ESM-integration proposal and therefore
+// Needs top-level await -- which this project cannot have, because Obsidian loads a `cjs` bundle. So the
+// Module is imported as an ASSET instead: `?url` gives its URL, and `build.assetsInlineLimit` makes that
+// URL a `data:` URL carried inside `main.js` rather than a path to a file no release would ship.
+declare module '*.wasm?url' {
+  const dataUrl: string;
+  export default dataUrl;
+}

package/templates/default/src/wasm.d.ts_webpack.ejs

@@ -0,0 +1,7 @@
+// Webpack's `experiments.asyncWebAssembly` emits the module as a SEPARATE `.wasm` chunk that the bundle
+// Fetches at runtime. Obsidian ships `main.js` and `styles.css` and nothing else, so that chunk never
+// Reaches a user. An `asset/inline` rule carries the module inside the bundle as a `data:` URL instead.
+declare module '*.wasm' {
+  const dataUrl: string;
+  export default dataUrl;
+}

package/templates/default/tsconfig.json_dev-utils.ejs

@@ -0,0 +1,34 @@
+{
+  "extends": "@tsconfig/strictest/tsconfig.json",
+  "compilerOptions": {
+    "allowArbitraryExtensions": true,
+    "allowImportingTsExtensions": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "importHelpers": true,
+    "inlineSourceMap": true,
+    "inlineSources": true,
+<%- render('compiler-options') -%>
+    "lib": [
+      "DOM",
+      "es2022"
+    ],
+    "module": "node16",
+    "moduleResolution": "node16",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "types": [
+      "node"<%- render('types') %>
+    ],
+    "verbatimModuleSyntax": true
+  },
+  "include": [
+    "./*.ts",
+    "./eslint.config.*ts",
+    "./scripts/**/*.ts",
+<%- render('include') -%>
+    "./src/**/*.ts",
+    "./src/**/*.tsx"
+  ]
+}

package/templates/default/tsconfig.json_dev-utils@compiler-options_i18next.ejs

@@ -0,0 +1 @@
+    "resolveJsonModule": true,

package/templates/default/tsconfig.json_dev-utils@compiler-options_lit.ejs

@@ -0,0 +1,2 @@
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,

package/templates/default/tsconfig.json_dev-utils@compiler-options_preact.ejs

@@ -0,0 +1,2 @@
+    "jsx": "react-jsx",
+    "jsxImportSource": "preact",

package/templates/default/tsconfig.json_dev-utils@compiler-options_react.ejs

@@ -0,0 +1 @@
+    "jsx": "react-jsx",

package/templates/default/tsconfig.json_dev-utils@compiler-options_solid.ejs

@@ -0,0 +1,2 @@
+    "jsx": "preserve",
+    "jsxImportSource": "solid-js",

package/templates/default/tsconfig.json_dev-utils@include_has-e2e.ejs

@@ -0,0 +1 @@
+    "./e2e/**/*.ts",

package/templates/default/tsconfig.json_dev-utils@include_svelte.ejs

@@ -0,0 +1 @@
+    "./src/**/*.svelte",

package/templates/default/tsconfig.json_dev-utils@include_vue.ejs

@@ -0,0 +1 @@
+    "./src/**/*.vue",

package/templates/default/tsconfig.json_dev-utils@types_jest.ejs

@@ -0,0 +1,2 @@
+,
+      "jest"

package/templates/default/tsconfig.json_dev-utils@types_svelte.ejs

@@ -0,0 +1,2 @@
+,
+      "svelte"

package/templates/default/tsconfig.json_dev-utils@types_wdio-obsidian.ejs

@@ -0,0 +1,5 @@
+,
+      "@wdio/globals/types",
+      "@wdio/mocha-framework",
+      "expect-webdriverio",
+      "wdio-obsidian-service"

package/templates/default/tsconfig.json_dev-utils@types_with-unofficial.ejs

@@ -0,0 +1,2 @@
+,
+      "@obsidian-typings/obsidian-public-latest"

package/templates/default/tsconfig.json_standalone.ejs

@@ -0,0 +1,47 @@
+{
+  "compilerOptions": {
+    "allowArbitraryExtensions": true,
+    "allowImportingTsExtensions": true,
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "importHelpers": true,
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "isolatedModules": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUncheckedIndexedAccess": true,
+    "strictBindCallApply": true,
+    "strictNullChecks": true,
+    "useUnknownInCatchVariables": true,
+<%- render('compiler-options') -%>
+    "lib": [
+      "DOM",
+      "es2022"
+    ],
+    "module": "node16",
+    "moduleResolution": "node16",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+<%# Not optional. With no `types` entry, NOTHING under `node_modules/@types` reaches the program -%>
+<%# — measured: zero packages, so every `node:fs` import and every `process` reference in `scripts/` -%>
+<%# fails with TS2591 even though `@types/node` is installed. Naming what the project needs is what -%>
+<%# the dev-utils config and this generator's own tsconfig both already do. -%>
+    "types": [
+      "node"<%- render('types') %>
+    ],
+    "verbatimModuleSyntax": true
+  },
+  "include": [
+    "./*.ts",
+<%# `./*.ts` does not match the `.mts` eslint config, and typed lint rules need every file ESLint -%>
+<%# reaches to be in this list — `eslint.config.mts` lints itself. Keep in step with `typeScriptFiles`. -%>
+    "./eslint.config.*ts",
+<%- render('include') -%>
+    "./scripts/**/*.ts",
+    "src/**/*.ts"<%- render('include-extra') %>
+  ]
+}

package/templates/default/tsconfig.json_standalone@compiler-options_i18next.ejs

@@ -0,0 +1 @@
+    "resolveJsonModule": true,

package/templates/default/tsconfig.json_standalone@compiler-options_lit.ejs

@@ -0,0 +1,2 @@
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,

package/templates/default/tsconfig.json_standalone@compiler-options_preact.ejs

@@ -0,0 +1,2 @@
+    "jsx": "react-jsx",
+    "jsxImportSource": "preact",

package/templates/default/tsconfig.json_standalone@compiler-options_react.ejs

@@ -0,0 +1 @@
+    "jsx": "react-jsx",

package/templates/default/tsconfig.json_standalone@compiler-options_solid.ejs

@@ -0,0 +1,2 @@
+    "jsx": "preserve",
+    "jsxImportSource": "solid-js",

package/templates/default/tsconfig.json_standalone@include-extra_preact.ejs

@@ -0,0 +1,2 @@
+,
+    "src/**/*.tsx"

package/templates/default/tsconfig.json_standalone@include-extra_react.ejs

@@ -0,0 +1,2 @@
+,
+    "src/**/*.tsx"

package/templates/default/tsconfig.json_standalone@include-extra_solid.ejs

@@ -0,0 +1,2 @@
+,
+    "src/**/*.tsx"

package/templates/default/tsconfig.json_standalone@include_has-e2e.ejs

@@ -0,0 +1 @@
+    "./e2e/**/*.ts",

package/templates/default/tsconfig.json_standalone@include_svelte.ejs

@@ -0,0 +1 @@
+    "src/**/*.svelte",

package/templates/default/tsconfig.json_standalone@include_vue.ejs

@@ -0,0 +1 @@
+    "src/**/*.vue",

package/templates/default/tsconfig.json_standalone@types_jest.ejs

@@ -0,0 +1,2 @@
+,
+      "jest"

package/templates/default/tsconfig.json_standalone@types_svelte.ejs

@@ -0,0 +1,2 @@
+,
+      "svelte"

package/templates/default/tsconfig.json_standalone@types_wdio-obsidian.ejs

@@ -0,0 +1,5 @@
+,
+      "@wdio/globals/types",
+      "@wdio/mocha-framework",
+      "expect-webdriverio",
+      "wdio-obsidian-service"

package/templates/default/tsconfig.json_standalone@types_with-unofficial.ejs

@@ -0,0 +1,2 @@
+,
+      "@obsidian-typings/obsidian-public-latest"

package/templates/default/versions.json.ejs

@@ -0,0 +1,3 @@
+{
+  "0.0.0": <%- JSON.stringify(_minAppVersion) %>
+}

package/templates/default/vite.config.ts.ejs

@@ -0,0 +1,3 @@
+// This file is required by vite at the root level.
+// The actual configuration lives in scripts/vite.config.ts
+export { config as default } from './scripts/vite.config.ts';

package/templates/default/vitest.config.ts_dev-utils.ejs

@@ -0,0 +1 @@
+export { config as default } from './scripts/vitest-config.ts';

package/templates/default/vitest.config.ts_standalone.ejs

@@ -0,0 +1,55 @@
+import { fileURLToPath } from 'node:url';
+import { defineConfig } from 'vitest/config';
+
+/**
+ * Where every `.wasm` import in a unit test's module graph is sent. ABSOLUTE, because a vite alias
+ * replacement is resolved relative to the IMPORTER -- so a relative one sends `src/wasm/answer.ts` to
+ * `src/wasm/scripts/wasm-module-stub.ts`, which does not exist.
+ */
+const WASM_MODULE_STUB_PATH = fileURLToPath(new URL('./scripts/wasm-module-stub.ts', import.meta.url));
+
+/**
+ * Where every stylesheet import in a unit test's module graph is sent, absolute for the same reason.
+ * `src/main.ts` imports one for its side effect, and on the `tailwind` styling the file it names is
+ * generated by the first build -- so a unit test run on a fresh clone would otherwise fail to resolve it.
+ */
+const STYLESHEET_STUB_PATH = fileURLToPath(new URL('./scripts/stylesheet-stub.ts', import.meta.url));
+
+export default defineConfig({
+<%- render('jsx') -%>
+  resolve: {
+    // The ARRAY form, not the object map: the two WebAssembly entries below have to be regular
+    // Expressions, and vite takes one form or the other for the whole list.
+    alias: [
+      // The `obsidian` npm package is types-only: `"main": ""`, and a published tarball carrying nothing
+      // But `.d.ts` files. Vite has to resolve the specifier before `vi.mock` is ever consulted, so the
+      // Setup file below is not enough on its own -- without this alias every test that touches the
+      // Plugin's own code fails to resolve `obsidian` at all. Anchored rather than left as a bare
+      // String, because a string `find` matches by PREFIX -- and its own replacement starts with
+      // `obsidian`, which would alias the alias.
+      { find: /^obsidian$/u, replacement: 'obsidian-test-mocks/obsidian' },
+      // Loading a `.wasm` is the bundler's job, and vitest resolves one through vite's own WebAssembly
+      // Helper, which fetches it from a URL that exists only under a dev server. Two patterns because
+      // Two bundlers do not write the import plainly: vite asks for the asset's URL
+      // (`./module.wasm?url`) and parcel uses a scheme (`data-url:./module.wasm`).
+      { find: /^.+\.wasm(?:\?.*)?$/u, replacement: WASM_MODULE_STUB_PATH },
+      { find: /^data-url:.+$/u, replacement: WASM_MODULE_STUB_PATH },
+      { find: /^.+\.(?:css|scss)$/u, replacement: STYLESHEET_STUB_PATH }
+    ]
+  },
+  test: {
+    // `obsidian-test-mocks`' `setup()` writes to `Document.prototype`, `Element.prototype` and
+    // `window`, none of which exist in the `node` environment.
+    environment: 'jsdom',
+    globals: true,
+    // Without this, vitest's default glob sweeps up `e2e/`, and `npm run test` reports the end-to-end
+    // Suite as three failed unit tests -- "browser is not defined" under wdio, and a missing
+    // `obsidian` package under obsidian-test. The dev-utils presets escape it because
+    // `defineObsidianPluginVitestConfig` gives each of its projects an `include` of its own, and the
+    // Jest answer escapes it through `roots: ['<rootDir>/src']`; this config had neither.
+    include: ['src/**/*.test.ts'],
+    setupFiles: [
+      'obsidian-test-mocks/vitest-setup'
+    ]
+  }
+});

package/templates/default/vitest.config.ts_standalone@jsx_solid.ejs

@@ -0,0 +1,11 @@
+  // Solid compiles its JSX with `babel-preset-solid`, so `tsconfig.json` sets `jsx: 'preserve'` and
+  // Leaves the JSX in place for the bundler. Vite refuses to parse a file in that state at all -- "make
+  // Sure to not set jsx to preserve" -- so the suites transform it with the automatic runtime instead,
+  // From `solid-js/h`, the entry point that publishes a `jsx-runtime` (plain `solid-js` does not).
+  // Reactivity is not compiled in, which unit tests do not need.
+  oxc: {
+    jsx: {
+      importSource: 'solid-js/h',
+      runtime: 'automatic'
+    }
+  },

package/templates/default/wdio.conf.ts.ejs

@@ -0,0 +1,21 @@
+<%# Shaped after wdio-obsidian-service's own documented config. The Obsidian version belongs in the -%>
+<%# capability (`browserVersion`), not in a service option: the previous `services: [['obsidian', -%>
+<%# { obsidianVersions: ['latest'] }]]` named an option the service does not have, and the whole object -%>
+<%# was missing the required `capabilities`, so `wdio.conf.ts` failed to type-check with TS2741. -%>
+export const config: WebdriverIO.Config = {
+  runner: 'local',
+  framework: 'mocha',
+  specs: ['./e2e/**/*.spec.ts'],
+  capabilities: [{
+    browserName: 'obsidian',
+    browserVersion: 'latest',
+    'wdio:obsidianOptions': {
+      plugins: ['.'],
+    },
+  }],
+  services: ['obsidian'],
+  mochaOpts: {
+    timeout: 60_000,
+    ui: 'bdd',
+  },
+};

package/templates/default/webpack.config.ts.ejs

@@ -0,0 +1,3 @@
+// This file is required by webpack at the root level.
+// The actual configuration lives in scripts/webpack.config.ts
+export { config as default } from './scripts/webpack.config.ts';