@slicemachine/adapter-next 0.3.2-dev-next-release.5 → 0.3.2-dev-next-release.6

package/src/lib/upsertSliceLibraryIndexFile.ts

@@ -6,9 +6,9 @@ import { NON_EDITABLE_FILE_BANNER } from "../constants";
 
 import { PluginOptions } from "../types";
 
-import { checkIsTypeScriptProject } from "./checkIsTypeScriptProject";
 import { pascalCase } from "./pascalCase";
 import { buildSliceLibraryDirectoryPath } from "./buildSliceLibraryDirectoryPath";
+import { getJSFileExtension } from "./getJSFileExtension";
 
 type UpsertSliceLibraryIndexFileArgs = {
 	libraryID: string;
@@ -17,17 +17,16 @@ type UpsertSliceLibraryIndexFileArgs = {
 export const upsertSliceLibraryIndexFile = async (
 	args: UpsertSliceLibraryIndexFileArgs,
 ): Promise<void> => {
-	const isTypeScriptProject = await checkIsTypeScriptProject({
+	const extension = await getJSFileExtension({
 		helpers: args.helpers,
 		options: args.options,
 	});
-
 	const filePath = path.join(
 		buildSliceLibraryDirectoryPath({
 			libraryID: args.libraryID,
 			helpers: args.helpers,
 		}),
-		isTypeScriptProject ? "index.ts" : "index.js",
+		`index.${extension}`,
 	);
 
 	const slices = await args.actions.readAllSliceModelsForLibrary({

package/src/types.ts

@@ -1,13 +1,57 @@
 export type PluginOptions = {
+	/**
+	 * Determines if generated files should be formatted using Prettier.
+	 *
+	 * @defaultValue `true`
+	 */
 	format?: boolean;
+
+	/**
+	 * Determines if Slice components should be lazy loaded when rendered.
+	 *
+	 * @defaultValue `true`
+	 */
 	lazyLoadSlices?: boolean;
+
+	/**
+	 * The filepath at which generated TypeScript types will be saved.
+	 *
+	 * @defaultValue `prismicio-types.d.ts`
+	 */
+	generatedTypesFilePath?: string;
 } & (
 	| {
+			/**
+			 * Determines if generated files should be written in TypeScript or
+			 * JavaScript.
+			 *
+			 * @defaultValue `true` if the project contains a `tsconfig.json`, `false` otherwise.
+			 */
 			typescript?: false;
+
+			/**
+			 * Determines if generated JavaScript files should use a `.jsx` file
+			 * extension.
+			 *
+			 * @defaultValue `false`
+			 */
 			jsxExtension?: boolean;
 	  }
 	| {
+			/**
+			 * Determines if generated files should be written in TypeScript or
+			 * JavaScript.
+			 *
+			 * @defaultValue `true` if the project contains a `tsconfig.json`, `false` otherwise.
+			 */
 			typescript: true;
+
+			/**
+			 * Determines if generated JavaScript files should use a `.jsx` file
+			 * extension.
+			 *
+			 * @defaultValue `false`
+			 */
 			jsxExtension?: never;
 	  }
 );

package/dist/lib/getJSOrTSXFileExtension.cjs

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const checkIsTypeScriptProject = require("./checkIsTypeScriptProject.cjs");
-const getJSOrTSXFileExtension = async (args) => {
-  const isTypeScriptProject = await checkIsTypeScriptProject.checkIsTypeScriptProject({
-    helpers: args.helpers,
-    options: args.options
-  });
-  if (isTypeScriptProject) {
-    return "tsx";
-  } else if (args.options.jsxExtension) {
-    return "jsx";
-  } else {
-    return "js";
-  }
-};
-exports.getJSOrTSXFileExtension = getJSOrTSXFileExtension;
-//# sourceMappingURL=getJSOrTSXFileExtension.cjs.map

package/dist/lib/getJSOrTSXFileExtension.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"getJSOrTSXFileExtension.cjs","sources":["../../../src/lib/getJSOrTSXFileExtension.ts"],"sourcesContent":["import { SliceMachineContext } from \"@slicemachine/plugin-kit\";\n\nimport type { PluginOptions } from \"../types\";\nimport { checkIsTypeScriptProject } from \"./checkIsTypeScriptProject\";\n\ntype GetJSOrTSXFileExtensionArgs = {\n\thelpers: SliceMachineContext<PluginOptions>[\"helpers\"];\n\toptions: SliceMachineContext<PluginOptions>[\"options\"];\n};\n\nexport const getJSOrTSXFileExtension = async (\n\targs: GetJSOrTSXFileExtensionArgs,\n): Promise<string> => {\n\tconst isTypeScriptProject = await checkIsTypeScriptProject({\n\t\thelpers: args.helpers,\n\t\toptions: args.options,\n\t});\n\n\tif (isTypeScriptProject) {\n\t\treturn \"tsx\";\n\t} else if (args.options.jsxExtension) {\n\t\treturn \"jsx\";\n\t} else {\n\t\treturn \"js\";\n\t}\n};\n"],"names":["checkIsTypeScriptProject"],"mappings":";;;AAUa,MAAA,0BAA0B,OACtC,SACoB;AACd,QAAA,sBAAsB,MAAMA,kDAAyB;AAAA,IAC1D,SAAS,KAAK;AAAA,IACd,SAAS,KAAK;AAAA,EAAA,CACd;AAED,MAAI,qBAAqB;AACjB,WAAA;AAAA,EAAA,WACG,KAAK,QAAQ,cAAc;AAC9B,WAAA;AAAA,EAAA,OACD;AACC,WAAA;AAAA,EACP;AACF;;"}

package/dist/lib/getJSOrTSXFileExtension.d.ts

@@ -1,8 +0,0 @@
-import { SliceMachineContext } from "@slicemachine/plugin-kit";
-import type { PluginOptions } from "../types";
-type GetJSOrTSXFileExtensionArgs = {
-    helpers: SliceMachineContext<PluginOptions>["helpers"];
-    options: SliceMachineContext<PluginOptions>["options"];
-};
-export declare const getJSOrTSXFileExtension: (args: GetJSOrTSXFileExtensionArgs) => Promise<string>;
-export {};

package/dist/lib/getJSOrTSXFileExtension.js

@@ -1,18 +0,0 @@
-import { checkIsTypeScriptProject } from "./checkIsTypeScriptProject.js";
-const getJSOrTSXFileExtension = async (args) => {
-  const isTypeScriptProject = await checkIsTypeScriptProject({
-    helpers: args.helpers,
-    options: args.options
-  });
-  if (isTypeScriptProject) {
-    return "tsx";
-  } else if (args.options.jsxExtension) {
-    return "jsx";
-  } else {
-    return "js";
-  }
-};
-export {
-  getJSOrTSXFileExtension
-};
-//# sourceMappingURL=getJSOrTSXFileExtension.js.map

package/dist/lib/getJSOrTSXFileExtension.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getJSOrTSXFileExtension.js","sources":["../../../src/lib/getJSOrTSXFileExtension.ts"],"sourcesContent":["import { SliceMachineContext } from \"@slicemachine/plugin-kit\";\n\nimport type { PluginOptions } from \"../types\";\nimport { checkIsTypeScriptProject } from \"./checkIsTypeScriptProject\";\n\ntype GetJSOrTSXFileExtensionArgs = {\n\thelpers: SliceMachineContext<PluginOptions>[\"helpers\"];\n\toptions: SliceMachineContext<PluginOptions>[\"options\"];\n};\n\nexport const getJSOrTSXFileExtension = async (\n\targs: GetJSOrTSXFileExtensionArgs,\n): Promise<string> => {\n\tconst isTypeScriptProject = await checkIsTypeScriptProject({\n\t\thelpers: args.helpers,\n\t\toptions: args.options,\n\t});\n\n\tif (isTypeScriptProject) {\n\t\treturn \"tsx\";\n\t} else if (args.options.jsxExtension) {\n\t\treturn \"jsx\";\n\t} else {\n\t\treturn \"js\";\n\t}\n};\n"],"names":[],"mappings":";AAUa,MAAA,0BAA0B,OACtC,SACoB;AACd,QAAA,sBAAsB,MAAM,yBAAyB;AAAA,IAC1D,SAAS,KAAK;AAAA,IACd,SAAS,KAAK;AAAA,EAAA,CACd;AAED,MAAI,qBAAqB;AACjB,WAAA;AAAA,EAAA,WACG,KAAK,QAAQ,cAAc;AAC9B,WAAA;AAAA,EAAA,OACD;AACC,WAAA;AAAA,EACP;AACF;"}

package/src/lib/getJSOrTSXFileExtension.ts

@@ -1,26 +0,0 @@
-import { SliceMachineContext } from "@slicemachine/plugin-kit";
-
-import type { PluginOptions } from "../types";
-import { checkIsTypeScriptProject } from "./checkIsTypeScriptProject";
-
-type GetJSOrTSXFileExtensionArgs = {
-	helpers: SliceMachineContext<PluginOptions>["helpers"];
-	options: SliceMachineContext<PluginOptions>["options"];
-};
-
-export const getJSOrTSXFileExtension = async (
-	args: GetJSOrTSXFileExtensionArgs,
-): Promise<string> => {
-	const isTypeScriptProject = await checkIsTypeScriptProject({
-		helpers: args.helpers,
-		options: args.options,
-	});
-
-	if (isTypeScriptProject) {
-		return "tsx";
-	} else if (args.options.jsxExtension) {
-		return "jsx";
-	} else {
-		return "js";
-	}
-};