@create-node-app/core 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+type Addon = {
+    url: string;
+    ignorePackage?: boolean;
+};
+
+declare const printEnvInfo: () => Promise<never>;
+type CnaOptions = {
+    projectName: string;
+    info?: boolean;
+    alias?: string;
+    srcDir?: string;
+    interactive?: boolean;
+    verbose?: boolean;
+    useNpm?: boolean;
+    nodeps?: boolean;
+    template?: string;
+    addons?: Addon[];
+};
+type CnaOptionsTransform = (options: CnaOptions) => Promise<CnaOptions>;
+/**
+ * Main procress to bootstrap the Node app using user options
+ * @param programName - Name of the program to bootstrap the Node application
+ * @param options - CnaOptions to bootstrap the Node application
+ * @param options.info - Print environment debug info
+ * @param options.alias - Metadata to specify alias, usefull for backends using webpack
+ * @param options.srcDir - Metadata to specify where to put the source code
+ * @param options.interactive - Specify if it is needed to use interactive mode or not
+ * @param options.verbose - Specify if it is needed to use verbose mode or not
+ * @param options.projectName - Project's name
+ * @param options.useNpm - Use npm mandatorily
+ * @param options.nodeps - Generate package.json file without installing dependencies
+ * @param options.template - Template to bootstrap the aplication
+ * @param options.extend - Extensions to apply for the boilerplate generation
+ * @param options.addons - Official extensions to apply
+ * @param transformOptions - Function to transform the options
+ */
+declare const createNodeApp: (programName: string, options: CnaOptions, transformOptions: CnaOptionsTransform) => Promise<void>;
+
+export { CnaOptions, CnaOptionsTransform, createNodeApp, printEnvInfo };