@twin.org/nameof-vitest-plugin 0.0.2-next.8 → 0.0.2

package/README.md

@@ -1,16 +1,20 @@
 # TWIN Nameof Vitest Plugin
 
-The regular TypeScript transformer cannot be used with ESBuild, so this plugin for Vitest performs the same transformation in a plugin.
+This package is part of the framework workspace and provides vitest plugin which perform the nameof transformation to support consistent development workflows across the ecosystem.
 
 ## Installation
 
 ```shell
-npm install @twin.org/nameof-vitest-plugin -D
+npm install -D @twin.org/nameof-vitest-plugin
 ```
 
 ## Configuration
 
-Configuration of the package is shown in [docs/configuration.md](docs/configuration.md)
+Configuration options are documented in [docs/configuration.md](docs/configuration.md)
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
 
 ## Reference
 

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./nameOfPlugin.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,mBAAmB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./nameOfPlugin.js\";\n"]}

package/dist/es/nameOfPlugin.js

@@ -0,0 +1,19 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { manual } from "@twin.org/nameof-transformer";
+/**
+ * Transforms the code using the nameOf plugin.
+ * @param code The code to transform.
+ * @param id The id of the file being transformed.
+ * @returns The transformed code.
+ */
+export function nameOfPluginTransform(code, id) {
+    return manual(code);
+}
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const NameOfPlugin = {
+    name: "name-of",
+    enforce: "pre",
+    transform: nameOfPluginTransform
+};
+//# sourceMappingURL=nameOfPlugin.js.map

package/dist/es/nameOfPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nameOfPlugin.js","sourceRoot":"","sources":["../../src/nameOfPlugin.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAGtD;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY,EAAE,EAAU;IAC7D,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AACrB,CAAC;AAED,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAW;IACnC,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,SAAS,EAAE,qBAAqB;CAChC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { manual } from \"@twin.org/nameof-transformer\";\nimport type { Plugin } from \"vitest/config\";\n\n/**\n * Transforms the code using the nameOf plugin.\n * @param code The code to transform.\n * @param id The id of the file being transformed.\n * @returns The transformed code.\n */\nexport function nameOfPluginTransform(code: string, id: string): string {\n\treturn manual(code);\n}\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const NameOfPlugin: Plugin = {\n\tname: \"name-of\",\n\tenforce: \"pre\",\n\ttransform: nameOfPluginTransform\n};\n"]}

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./nameOfPlugin";
+export * from "./nameOfPlugin.js";

package/dist/types/nameOfPlugin.d.ts

@@ -1,3 +1,9 @@
 import type { Plugin } from "vitest/config";
-export declare const nameOfPluginTransform: (code: string, id: string) => string;
+/**
+ * Transforms the code using the nameOf plugin.
+ * @param code The code to transform.
+ * @param id The id of the file being transformed.
+ * @returns The transformed code.
+ */
+export declare function nameOfPluginTransform(code: string, id: string): string;
 export declare const NameOfPlugin: Plugin;