New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

creatium

Package Overview
Dependencies
Maintainers
0
Versions
18
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

creatium - npm Package Compare versions

Comparing version 0.1.9 to 0.1.10

7

package.json
{
"name": "creatium",
"version": "0.1.9",
"version": "0.1.10",
"description": "Build your create-bins quickly and easily",

@@ -15,2 +15,3 @@ "keywords": [

],
"homepage": "https://creatium.pigeonposse.com/guide/core",
"bugs": {

@@ -46,3 +47,3 @@ "url": "https://github.com/pigeonposse/creatium/issues",

"boxen": "8.0.1",
"chalk": "5.3.0",
"chalk": "5.4.1",
"columnify": "1.6.0",

@@ -62,3 +63,3 @@ "conf": "13.1.0",

"@types/yargs": "17.0.33",
"@creatium/repo-config": "0.1.8"
"@creatium/repo-config": "0.1.9"
},

@@ -65,0 +66,0 @@ "publishConfig": {

1507

README.md

@@ -1,4 +0,1 @@

<!-- AUTOGEN BY DOVENV - START
Do not edit this file -->
# Creatium

@@ -9,35 +6,18 @@

[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge&logoColor=white)](https://pigeonposse.com/?popup=donate)
[![Github](https://img.shields.io/badge/Github-black?style=for-the-badge&logo=github&logoColor=white)](https://github.com/pigeonposse)
[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/pigeonposse_)
[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/pigeon.posse/)
[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@pigeonposse)
[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logoColor=white&logo=twitter)](https://twitter.com/pigeonposse_)
[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logoColor=white&logo=instagram)](https://www.instagram.com/pigeon.posse/)
[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logoColor=white&logo=medium)](https://medium.com/@pigeonposse)
[![BANNER](https://github.com/pigeonposse/creatium/blob/main/docs/public/banner.png?raw=true)](https://creatium.pigeonposse.com)
[![License](https://img.shields.io/github/license/pigeonposse/creatium?color=green&style=for-the-badge&logoColor=white)](https://github.com/pigeonposse/creatium/blob/main/LICENSE)
[![Version](https://img.shields.io/npm/v/creatium?color=blue&style=for-the-badge&label=Version)](https://www.npmjs.com/package/creatium)
[![License](https://img.shields.io/github/license/pigeonposse/creatium?style=for-the-badge&color=green&logoColor=white)](/LICENSE)
[![Version](https://img.shields.io/npm/v/creatium?style=for-the-badge&color=blue&label=Version)](https://www.npmjs.com/package/creatium)
## 🤔 What is it `creatium`?
Build your create-bins quickly and easily
`creatium` is a JavaScript Library for creating project templates.
> Useful for create-binaries like `pnpm create backan`
[Read more](https://www.npmjs.com/package/creatium)
Demo of the `creatium` library:
![demo](https://github.com/pigeonposse/creatium/raw/main/docs/public/example.gif)
## Table of contents
- [🤔 What is it `creatium`?](#-what-is-it-creatium)
- [📄 Description](#-description)
- [What is it `creatium`?](#what-is-it-creatium)
- [🔑 Installation](#-installation)
- [🚀 Usage](#-usage)
- [Simple use case](#simple-use-case)
- [Advanced use case](#advanced-use-case)
- [Api documentation](#api-documentation)
- [Classes](#classes)
- [Type Aliases](#type-aliases)
- [Variables](#variables)
- [More](#more)
- [👨‍💻 Development](#-development)

@@ -49,1457 +29,38 @@ - [☕ Donate](#-donate)

## 📄 Description
## What is it `creatium`?
Build your create-bins quickly and easily
`creatium` is a JavaScript Library for creating project templates.
> Useful for create-binaries like `pnpm create backan`
## 🔑 Installation
[Read more](https://www.npmjs.com/package/creatium)
```bash
npm install creatium
# or
pnpm add creatium
# or
yarn add creatium
# or
deno install creatium
# or
bun add creatium
```
Demo of the `creatium` library:
## 🚀 Usage
![demo](https://github.com/pigeonposse/creatium/raw/main/docs/public/example.gif)
Create a cli and a library project with `creatium`
### Simple use case
Recommended for most use cases.
## 🔑 Installation
Below we show a practical example.
> {my-library-name} refers to the name of your library. Change it to the name of your library.
#### Project structure
Create a project with the following structure:
```text
📂 data
├── 📂 templates
│ ├── 📂 js-project
│ │ └── ... (files, folders...)
│ └── 📂 ts-project
│ └── ... (files, folders...)
📂 src
├── bin.js
├── lib.js
├── core.js
📄 package.json
│
```
#### src/core.js
Create a new instance of `creatium` and export it as `core`
```javascript
import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
import { version } from './package.json'
import { Creatium } from 'creatium'
const currentDir = join( dirname( fileURLToPath( import.meta.url ) ) )
const templatesDir = join( currentDir, '..', 'data','templates' ) // absolute path for `templates` folder
export const core = new Creatium( {
name: '{my-library-name}', // recomended use the name of your package.json becasue it will be used by updater function
version,
templates : {
js : {
input : join( templatesDir, 'js-project' ),
name : 'JavaScript project',
},
ts : {
input : join( templatesDir, 'ts-project' ),
name : 'TypeScript project',
},
},
} )
```
#### src/bin.js
Create a bin file and call the `cli` method of the `core` instance.
```javascript
#!/usr/bin/env node
// create cli
import { core } from './core.js'
await core.cli()
```
#### src/lib.js
Create a library file and export the `create` function for use outside.
```javascript
import { core } from './core.js'
/**
* Create project template.
* @param {Parameters<typeof core.build>[0]} params - The parameters required for creation.
* @returns {Promise<Object>} A promise that resolves to the result of the creation process.
*/
export const create = async ( params ) => {
return await core.build( params )
}
```
#### package.json
Create a package.json file with the following structure:
```json
{
"name": "create-{my-library-name}",
"version": "0.0.1",
"type": "module",
"main": "src/lib.js",
"module": "src/lib.js",
"bin": {
"create-{my-library-name}": "src/bin.js"
},
"scripts": {
"dev": "node src/bin.js",
},
"files": [
"src",
"data",
]
}
```
#### Data (templates)
Create a data folder with your `templates`.
```text
📂 data
├── 📂 templates
│ ├── 📂 js-project
│ │ └── ... (files, folders...)
│ ├── 📂 ts-project
│ │ └── ... (files, folders...)
│
```
#### Execute
Once the package is published you can use it with:
```bash
npm create {my-library-name}
```bash
npm install creatium
# or
pnpm create {my-library-name}
pnpm install creatium
# or
yarn create {my-library-name}
yarn add creatium
# or
bun create {my-library-name}
bun add creatium
# or
deno create {my-library-name}
deno add creatium
```
### Advanced use case
## More
You can use the `CreatiumCore` class to create a fully customized __cli__ and __user prompt__.
- [Core](https://creatium.pigeonposse.com/guide/core)
- [Create](https://creatium.pigeonposse.com/guide/create)
This class is the one that the main `Creatium` class uses to function.
Below we show a practical example.
> {my-library-name} refers to the name of your library. Change it to the name of your library.
#### Project structure
Create a project with the following structure:
```text
📂 data
├── 📂 templates
│ ├── 📂 js-project
│ │ └── ... (files, folders...)
│ ├── 📂 ts-project
│ │ └── ... (files, folders...)
│ 📂 partials
│ ├── 📂 workspace (used in example)
│ │ └── ... (files, folders...)
│ └── 📂 .../
📂 src
├── bin.js
├── lib.js
├── core.js
📄 package.json
│
```
#### src/core.js
- Create a new instance of `CreatiumCore` and export it as `core`
- Create and export `createTemplate` function for use outside in `src/lib.js` and `src/bin.js`
```javascript
import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
import { version } from './package.json'
import { CreatiumCore } from 'creatium'
const currentDir = join( dirname( fileURLToPath( import.meta.url ) ) )
const dataDir = join( currentDir, '..', 'data' ) // Absolute path for the `data` folder
const partialsDir = join( dataDir, 'partials' )
const templatesDir = join( dataDir, 'templates' )
export const core = new CreatiumCore( {
name: '{my-library-name}',
version,
updater : true,
cache : true,
prompt : {
output : {
type : 'output',
alias : [ 'o' ],
desc : 'Where do you want create a new project?',
},
name : {
type : 'name',
alias : [ 'n' ],
},
wsFiles : {
type : 'boolean',
desc : 'Include workspace files',
promptMsg : 'Do you want add a workspace files like LICENSE, .npmrc and .gitignore?',
},
desc : {
type : 'text',
desc : 'Add a description of your project',
},
input : {
type : 'template',
desc : 'Select template',
options : {
js : {
input : join( templatesDir, 'js-project' ),
name : 'JavaScript project',
},
ts : {
input : join( templatesDir, 'ts-project' ),
name : 'TypeScript project',
},
},
},
install : {
type : 'install',
desc : 'Select package manager',
onlyOptions : [
'pnpm',
'npm',
'deno',
], // Only these package managers can be selected
},
openEditor : { type: 'openEditor' },
},
} )
/**
* Function for create a new project template.
* @param {Awaited<ReturnType<typeof core.cli>>} params - The values to create the template.
* @returns {Promise<void>} - A promise that resolves when the template is created.
*/
export const createTemplate = async ( params ) => {
try {
const {
output,
input,
install,
openEditor,
name,
wsFiles,
} = params
const { prompt } = core.utils // extract prompt utils and use it for write in prompt line
// Copy the workspace partials folder if wsFiles is true.
// this must be first than the creatium.createTemplate because creatium.createTemplate ends the line process
// and wsFiles must be override in the creatium.createTemplate function.
if ( wsFiles ) {
await core.copyDir( {
input : join( partialsDir, 'workspace' ),
output,
} )
prompt.log.success( 'Added workspace files!' )
}
// example of dynamic pkg json config
const pkgJSON = {
name : name,
description : consts.desc,
version : '0.0.1',
license : wsFiles ? 'MIT' : undefined
}
await core.createTemplate( {
output,
input,
install,
openEditor,
name,
// custom parameters for been susbstituted in the template files
consts : {
// example of dynamic pkg json config
pkg : JSON.stringify( pkgJSON, null, 2 ),
},
} )
}
catch ( error ) {
if ( error instanceof Error ) prompt.log.error( error.message ) // show error message in prompt line
else console.error( 'Unexpected error:', error )
core.cancel() // cancel the process
}
}
```
#### src/bin.js
Create a bin file and call the `cli` method of the `core` instance.
```javascript
#!/usr/bin/env node
import { core, createTemplate } from './core.js'
// Run the CLI and obtain the prompt values
const res = await core.cli()
// Call to the create function for create the template
await createTemplate( res )
```
#### src/lib.js
Create a library file and export the `create` function for use outside.
```javascript
import { core, createTemplate } from './core.js'
/**
* Create project template.
* @param {Parameters<typeof core.build>[0]} params - The parameters required for creation.
* @returns {Promise<Object>} A promise that resolves to the result of the creation process.
*/
export const create = async ( params ) => {
const res = await core.build( params )
await createTemplate( res )
return res
}
```
#### package.json
Create a package.json file with the following structure:
```json
{
"name": "create-{my-library-name}",
"version": "0.0.1",
"type": "module",
"main": "src/lib.js",
"module": "src/lib.js",
"bin": {
"create-{my-library-name}": "src/bin.js"
},
"scripts": {
"dev": "node src/bin.js",
},
"files": [
"src",
"data",
]
}
```
#### Data (templates & partials)
Create a data folder with your templates and your partials.
```text
📂 data
├── 📂 templates
│ ├── 📂 js-project
│ │ └── ... (files, folders...)
│ ├── 📂 ts-project
│ │ └── ... (files, folders...)
│ 📂 partials
│ ├── 📂 workspace (used in example)
│ │ └── ... (files, folders...)
│ └── 📂 .../
│
```
#### Execute
Once the package is published you can use it with:
```bash
npm create {my-library-name}
# or
pnpm create {my-library-name}
# or
yarn create {my-library-name}
# or
bun create {my-library-name}
# or
deno create {my-library-name}
```
## Api documentation
### Classes
#### Creatium
Class of `Creatium` for create project templates (CLI and Library).
##### Example
```ts
//////////////// core.js ///////////////////
import { Creatium } from 'creatium'
export const core = new Creatium({
name: 'My Project',
version: '1.0.0',
templates: {
...
},
})
//////////////// bin.js ///////////////////
import { core } from './core.js'
core.cli()
//////////////// lib.js ///////////////////
import { core } from './core.js'
export const create = core.build
```
##### Constructors
###### new Creatium()
```ts
new Creatium(options: {
cache: boolean;
consts: Record<string, string>;
intro: false | (data: HookParams) => Response<void>;
name: string;
onCancel: false | (data: HookParams) => Response<void>;
opts: {
install: false | [
| "bun"
| "deno"
| "npm"
| "pnpm"
| "yarn",
| "bun"
| "deno"
| "npm"
| "pnpm"
| "yarn", ...("bun" | "deno" | "npm" | "pnpm" | "yarn")[]];
name: boolean;
openEditor: false | ["code" | "subl" | "webstorm", "code" | "subl" | "webstorm", ...("code" | "subl" | "webstorm")[]];
};
outro: false | (data: HookParams) => Response<void>;
templates: {};
updater: boolean;
version: string;
}): Creatium
```
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options` | `object` | - |
| `options.cache`? | `boolean` | Use cache **Default** `true` |
| `options.consts`? | `Record`\<`string`, `string`\> | Add consts to use in your templates. |
| `options.intro`? | `false` \| (`data`: `HookParams`) => `Response`\<`void`\> | Set custom intro |
| `options.name` | `string` | Set name of you project |
| `options.onCancel`? | `false` \| (`data`: `HookParams`) => `Response`\<`void`\> | Set custom function foor when user cancels the process |
| `options.opts`? | `object` | Set your prompt options |
| `options.opts.install`? | `false` \| [ \| `"bun"` \| `"deno"` \| `"npm"` \| `"pnpm"` \| `"yarn"`, \| `"bun"` \| `"deno"` \| `"npm"` \| `"pnpm"` \| `"yarn"`, ...("bun" \| "deno" \| "npm" \| "pnpm" \| "yarn")\[\]] | Active/deactivate the install prompt Also, You can set the installators that you want to use. |
| `options.opts.name`? | `boolean` | Active/deactivate the name prompt |
| `options.opts.openEditor`? | `false` \| [`"code"` \| `"subl"` \| `"webstorm"`, `"code"` \| `"subl"` \| `"webstorm"`, ...("code" \| "subl" \| "webstorm")\[\]] | Active/deactivate the openEditor prompt. Also, You can set the editors that you want to use. |
| `options.outro`? | `false` \| (`data`: `HookParams`) => `Response`\<`void`\> | Set custom outro |
| `options.templates` | `object` | Set your template ooptions |
| `options.updater`? | `boolean` | Use updater **Default** `false` |
| `options.version` | `string` | Set version of you current project Used in for the updater notifications. |
###### Returns
[`Creatium`](index.md#creatium)
##### Methods
###### build()
```ts
build(values?: {
input: string;
install: Installer;
name: string;
openEditor: TextEditor;
output: string;
}, opts?: CreateOpts): Promise<{
input: string;
install: undefined;
name: undefined;
openEditor: undefined;
output: string;
}>
```
A simplified version of the `build` method from the main class.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `values`? | `object` | The values to override the CLI prompts. If not set, the CLI prompts will be executed. |
| `values.input`? | `string` | Set the input path or the template key |
| `values.install`? | `Installer` | Set the installer |
| `values.name`? | `string` | Set the name of the template |
| `values.openEditor`? | `TextEditor` | Open editor |
| `values.output`? | `string` | Set the output path |
| `opts`? | [`CreateOpts`](index.md#createopts) | The options to pass to the CLI. |
###### Returns
`Promise`\<\{
`input`: `string`;
`install`: `undefined`;
`name`: `undefined`;
`openEditor`: `undefined`;
`output`: `string`;
\}\>
A promise resolving to the prompt values obtained after executing the CLI.
| Name | Type |
| ------ | ------ |
| `input`? | `string` |
| `install`? | `undefined` |
| `name`? | `undefined` |
| `openEditor`? | `undefined` |
| `output`? | `string` |
###### Examples
```ts
// simple usage
await core.build()
```
```ts
// custom usage
await core.build( { args : process.argv.slice(4), hideBin : false } )
```
###### cli()
```ts
cli(props?: CliOpts): Promise<{
input: string;
install: undefined;
name: undefined;
openEditor: undefined;
output: string;
}>
```
A simplified version of the `cli` method from the main class.
Initializes and executes the command-line interface (CLI) process.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `props`? | [`CliOpts`](index.md#cliopts) | Optional CLI options to configure the initialization process. |
###### Returns
`Promise`\<\{
`input`: `string`;
`install`: `undefined`;
`name`: `undefined`;
`openEditor`: `undefined`;
`output`: `string`;
\}\>
A promise resolving to the prompt values obtained after executing the CLI.
| Name | Type |
| ------ | ------ |
| `input`? | `string` |
| `install`? | `undefined` |
| `name`? | `undefined` |
| `openEditor`? | `undefined` |
| `output`? | `string` |
###### Examples
```ts
// simple usage
await core.cli()
```
```ts
// custom usage
await core.cli( { args : process.argv.slice(4), hideBin : false } )
```
#### CreatiumCore\<C\>
Customizable class of `Creatium` for create project templates (CLI and Library).
##### Example
```ts
//////////////// core.js ///////////////////
export const core = new CreatiumCore({
name: 'My Project',
version: '1.0.0',
prompts: {
...
},
...
})
//////////////// bin.js ///////////////////
import { core } from './core.js'
const res = await core.cli()
// do something with res...
await core.createTemplate( res )
//////////////// lib.js ///////////////////
import { core } from './core.js'
export const create = async (args) => {
const res = await core.build( args )
// do something with res...
await core.createTemplate( res )
}
```
##### Type Parameters
| Type Parameter | Default type | Description |
| ------ | ------ | ------ |
| `C` *extends* [`Config`](index.md#config) | [`Config`](index.md#config) | |
##### Accessors
###### debugMode
###### Set Signature
```ts
set debugMode(value: boolean): void
```
Force debug mode
###### Parameters
| Parameter | Type |
| ------ | ------ |
| `value` | `boolean` |
###### Returns
`void`
##### Constructors
###### new CreatiumCore()
```ts
new CreatiumCore<C>(config: C): CreatiumCore<C>
```
###### Parameters
| Parameter | Type |
| ------ | ------ |
| `config` | `C` |
###### Returns
[`CreatiumCore`](index.md#creatiumcorec)\<`C`\>
##### Methods
###### build()
```ts
build(values?: { [K in string | number | symbol]: { [K in string | number | symbol]: { [K in string | number | symbol]?: { [K in string | number | symbol]: ((...)[(...)] extends Object ? (...) extends (...) ? (...) : (...) : never)[K] } }[K] }[K] }, opts?: CreateOpts): Promise<{ [K in string | number | symbol]: { [K in string | number | symbol]?: { [K in string | number | symbol]: (C["prompt"][K] extends Object ? T extends keyof OptionsClasses ? { [K in (...) | (...) | (...)]: (...)[(...)] } : never : never)[K] } }[K] }>
```
Initialize the CLI and executes the callback function passed in the config.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `values`? | \{ \[K in string \| number \| symbol\]: \{ \[K in string \| number \| symbol\]: \{ \[K in string \| number \| symbol\]?: \{ \[K in string \| number \| symbol\]: ((...)\[(...)\] extends Object ? (...) extends (...) ? (...) : (...) : never)\[K\] \} \}\[K\] \}\[K\] \} | The values to override the CLI prompts. If not set, the CLI prompts will be executed. |
| `opts`? | [`CreateOpts`](index.md#createopts) | The options to pass to the CLI. |
###### Returns
`Promise`\<\{ \[K in string \| number \| symbol\]: \{ \[K in string \| number \| symbol\]?: \{ \[K in string \| number \| symbol\]: (C\["prompt"\]\[K\] extends Object ? T extends keyof OptionsClasses ? \{ \[K in (...) \| (...) \| (...)\]: (...)\[(...)\] \} : never : never)\[K\] \} \}\[K\] \}\>
The result of the callback function.
###### cancel()
```ts
cancel(message?: string): Promise<void>
```
Cancels the current process and exits with code 0.
If a `message` is provided, it will be displayed in the console.
If `onCancel` is set in the config, it will be called with the current data.
If `onCancel` is not set, a default message will be displayed.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `message`? | `string` | The message to display before exiting. |
###### Returns
`Promise`\<`void`\>
###### cli()
```ts
cli(props?: CliOpts): Promise<{ [K in string | number | symbol]: { [K in string | number | symbol]?: { [K in string | number | symbol]: (C["prompt"][K] extends Object ? T extends keyof OptionsClasses ? { [K in (...) | (...) | (...)]: (...)[(...)] } : never : never)[K] } }[K] }>
```
Initializes and executes the command-line interface (CLI) process.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `props`? | [`CliOpts`](index.md#cliopts) | Optional CLI options to configure the initialization process. |
###### Returns
`Promise`\<\{ \[K in string \| number \| symbol\]: \{ \[K in string \| number \| symbol\]?: \{ \[K in string \| number \| symbol\]: (C\["prompt"\]\[K\] extends Object ? T extends keyof OptionsClasses ? \{ \[K in (...) \| (...) \| (...)\]: (...)\[(...)\] \} : never : never)\[K\] \} \}\[K\] \}\>
A promise resolving to the prompt values obtained after executing the CLI.
###### Examples
```ts
// simple usage
await core.cli()
```
```ts
// custom usage
await core.cli( { args : process.argv.slice( 4), hideBin : false } )
```
###### copyDir()
```ts
copyDir(data: {
input: string;
output: string;
}): Promise<void>
```
Copy a directory from input path to output path.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `object` | Options object with input and output paths. |
| `data.input` | `string` | The path to the directory to copy. |
| `data.output` | `string` | The path to the destination directory. |
###### Returns
`Promise`\<`void`\>
- Resolves when the directory has been copied.
###### Example
```ts
const copyResult = await core.copyDir({
input : '/path/to/sourceDir',
output: '/path/to/destinationDir',
})
```
###### createTemplate()
```ts
createTemplate(values: CreateTemplateOpts): Promise<void>
```
Create a new project template.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `values` | [`CreateTemplateOpts`](index.md#createtemplateopts) | The values to create the template. |
###### Returns
`Promise`\<`void`\>
- A promise that resolves when the template is created.
###### Examples
```ts
// basic usage
await core.createTemplate( { input : 'my/template/path', output : 'my/project/path' } )
```
```ts
// custom usage
await core.createTemplate( {
input : 'my/template/path',
output : 'my/project/path',
install : 'pnpm',
open : 'vscode',
consts : {
version : '1.0.0',
header : '// Template generated by Creatium. a project from PigeonPosse',
},
} )
```
###### getTemplateInput()
```ts
getTemplateInput(input?: {
input: string;
}): Promise<undefined | string>
```
Return the input path of a template by name or path.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `input`? | `object` | The name of the template or the path to the template. |
| `input.input`? | `string` | - |
###### Returns
`Promise`\<`undefined` \| `string`\>
The input path of the template or undefined if not found.
###### Examples
```ts
// with template path
const input = await core.getTemplateInput( { input : 'my/template/path' } )
```
```ts
// With template key
// template key must be specified in the config prompt secction.
const input = await core.getTemplateInput( { input : 'templateKey' )
```
###### install()
```ts
install(options?: {
input: string;
installer: Installer;
}): Promise<void>
```
Installs the project with the given package manager.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options`? | `object` | The options to install. |
| `options.input`? | `string` | The path to the folder. If not provided, the current directory is used. |
| `options.installer`? | `Installer` | The package manager to use for the installation. |
###### Returns
`Promise`\<`void`\>
###### Example
```ts
await core.install( {
installer : 'pnpm',
input : 'my/project/path',
} )
```
###### intro()
```ts
intro(message?: string): Promise<void>
```
Intro prompt line.
If the parameter `message` is provided, it will be used as the intro message.
If the `intro` option is a function, it will be called with the `this.#data` as the argument.
If the `intro` option is undefined, the default intro message will be used.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `message`? | `string` | The intro message. |
###### Returns
`Promise`\<`void`\>
###### openEditor()
```ts
openEditor(params: {
editor: TextEditor;
input: string;
}): Promise<void>
```
Open the project in the given editor.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `params` | `object` | The parameters for opening the editor. |
| `params.editor`? | `TextEditor` | The editor to open the project in. |
| `params.input`? | `string` | The input path. If not provided, the current directory is used. |
###### Returns
`Promise`\<`void`\>
###### Example
```ts
await core.openEditor( {
editor : 'vscode',
input : 'my/project/path',
})
```
###### outro()
```ts
outro(message?: string): Promise<void>
```
Outro prompt line.
If the parameter `message` is provided, it will be used as the outro message.
If the `outro` option is a function, it will be called with the `this.#data` as the argument.
If the `outro` option is undefined, the default outro message will be used.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `message`? | `string` | The outro message. |
###### Returns
`Promise`\<`void`\>
###### replacePlaceholders()
```ts
replacePlaceholders(args: {
input: string;
inputOpts: Options;
params: Params;
}): Promise<void>
```
Replaces placeholders in files within the specified directory.
This function searches for files in the provided input directory and replaces
placeholders within those files using the specified parameters. The placeholders
in the content are replaced with values from the `params` object.
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `args` | `object` | The arguments object. |
| `args.input`? | `string` | The directory path containing files with placeholders. |
| `args.inputOpts`? | `Options` | - |
| `args.params`? | `Params` | An object containing key-value pairs for replacing placeholders. |
###### Returns
`Promise`\<`void`\>
A Promise that resolves once all placeholders have been replaced.
###### Example
```ts
await core.replacePlaceholders( {
input : 'my/project/path',
params : { consts: { version: '1.0.0' }, prompt: { name: 'My Project' } },
})
```
###### updateNotify()
```ts
updateNotify(opts?: {
custom: (info?: UpdateInfo) => Response<void>;
opts: NotifyOptions;
}): Promise<void>
```
Shows a notification if the current package is outdated.
**information**: If this 'custom' function is provided, the default
notification will not be shown.
---
###### Parameters
| Parameter | Type | Description |
| ------ | ------ | ------ |
| `opts`? | `object` | Options for the update notification. |
| `opts.custom`? | (`info`?: `UpdateInfo`) => `Response`\<`void`\> | A custom function to run with the update |
| `opts.opts`? | `NotifyOptions` | Options for the `update-notifier` package. |
###### Returns
`Promise`\<`void`\>
###### Examples
```ts
// With default options. Recommended for most use cases.
await core.updateNotify()
```
```ts
// With custom options
await core.updateNotify({ opts: { ... } })
```
```ts
// With custom function
await core.updateNotify({ custom: () => {} })
```
##### Properties
| Property | Type |
| ------ | ------ |
| `config` | `C` |
| `utils` | `__module` |
### Type Aliases
#### CliOpts
```ts
type CliOpts: {
args: string[];
hideBin: boolean;
};
```
##### Type declaration
| Name | Type | Description |
| ------ | ------ | ------ |
| `args`? | `string`[] | Arguments to pass to the command **Default** `process.argv.slice(2)` |
| `hideBin`? | `boolean` | Hide the first two arguments **Default** `false` |
#### Config
```ts
type Config: {
cache: boolean;
hooks: {
afterPrompt: <D>(data: D) => Response<D | undefined>;
beforePrompt: <D>(data: D) => Response<D | undefined>;
};
intro: (data: HookParams) => Response<void> | false;
name: string;
onCancel: (data: HookParams) => Response<void> | false;
outro: (data: HookParams) => Response<void> | false;
prompt: OptionsParams;
updater: boolean;
version: string;
};
```
##### Type declaration
| Name | Type | Description |
| ------ | ------ | ------ |
| `cache`? | `boolean` | Use cache **Default** `true` |
| `hooks`? | \{ `afterPrompt`: \<`D`\>(`data`: `D`) => `Response`\<`D` \| `undefined`\>; `beforePrompt`: \<`D`\>(`data`: `D`) => `Response`\<`D` \| `undefined`\>; \} | hooks for |
| `hooks.afterPrompt`? | \<`D`\>(`data`: `D`) => `Response`\<`D` \| `undefined`\> | - |
| `hooks.beforePrompt`? | \<`D`\>(`data`: `D`) => `Response`\<`D` \| `undefined`\> | - |
| `intro`? | (`data`: `HookParams`) => `Response`\<`void`\> \| `false` | Set custom intro |
| `name` | `string` | Set name of you project |
| `onCancel`? | (`data`: `HookParams`) => `Response`\<`void`\> \| `false` | Set custom function foor when user cancels the process |
| `outro`? | (`data`: `HookParams`) => `Response`\<`void`\> \| `false` | Set custom outro |
| `prompt` | `OptionsParams` | Set you prompts config |
| `updater`? | `boolean` | Use updater **Default** `false` |
| `version` | `string` | Set version of you current project Used in for the updater notifications. |
#### CreateOpts
```ts
type CreateOpts: CliOpts & {
activeCli: boolean;
};
```
##### Type declaration
| Name | Type | Description |
| ------ | ------ | ------ |
| `activeCli`? | `boolean` | Options for activate cli. **Default** `true` |
#### CreateTemplateOpts
```ts
type CreateTemplateOpts: {
consts: Record<string, string>;
input: string;
install: Installer;
name: string;
openEditor: TextEditor;
output: string;
};
```
##### Type declaration
| Name | Type | Description |
| ------ | ------ | ------ |
| `consts`? | `Record`\<`string`, `string`\> | Add consts to use in your templates. |
| `input`? | `string` | Set the input path or the template key |
| `install`? | `Installer` | Set the installer |
| `name`? | `string` | Set the name of the template |
| `openEditor`? | `TextEditor` | Open editor |
| `output`? | `string` | Set the output path |
### Variables
#### env
```ts
const env: {
isBrowser: boolean;
isBun: boolean;
isDeno: boolean;
isJsDom: boolean;
isNode: boolean;
isWebWorker: boolean;
} = _env;
```
Environment functions
##### Type declaration
| Name | Type |
| ------ | ------ |
| `isBrowser` | `boolean` |
| `isBun` | `boolean` |
| `isDeno` | `boolean` |
| `isJsDom` | `boolean` |
| `isNode` | `boolean` |
| `isWebWorker` | `boolean` |
#### INSTALLER
```ts
const INSTALLER: {
BUN: 'bun';
DENO: 'deno';
NONE: 'none';
NPM: 'npm';
PNPM: 'pnpm';
YARN: 'yarn';
};
```
installer values used in `install` option.
##### Type declaration
| Name | Type | Default value |
| ------ | ------ | ------ |
| `BUN` | `"bun"` | 'bun' |
| `DENO` | `"deno"` | 'deno' |
| `NONE` | `"none"` | 'none' |
| `NPM` | `"npm"` | 'npm' |
| `PNPM` | `"pnpm"` | 'pnpm' |
| `YARN` | `"yarn"` | 'yarn' |
#### OPTION
```ts
const OPTION: {
array: 'array';
boolean: 'boolean';
install: 'install';
multiselect: 'multiselect';
name: 'name';
number: 'number';
openEditor: 'openEditor';
output: 'output';
path: 'path';
select: 'select';
template: 'template';
text: 'text';
void: 'void';
};
```
Object of the CREATIUM types
##### Type declaration
| Name | Type | Default value |
| ------ | ------ | ------ |
| `array` | `"array"` | 'array' |
| `boolean` | `"boolean"` | 'boolean' |
| `install` | `"install"` | 'install' |
| `multiselect` | `"multiselect"` | 'multiselect' |
| `name` | `"name"` | 'name' |
| `number` | `"number"` | 'number' |
| `openEditor` | `"openEditor"` | 'openEditor' |
| `output` | `"output"` | 'output' |
| `path` | `"path"` | 'path' |
| `select` | `"select"` | 'select' |
| `template` | `"template"` | 'template' |
| `text` | `"text"` | 'text' |
| `void` | `"void"` | 'void' |
#### prompt
```ts
const prompt: {
box: (opts: {
opts: Options;
type: PromptLineMethod;
value: string;
}) => void;
columns: (opts: {
opts: GlobalOptions;
type: PromptLineMethod;
value: ColumnData;
}) => void;
log: {
error: (message: string) => void;
info: (message: string) => void;
message: (message?: string, { symbol }?: LogMessageOptions) => void;
step: (message: string) => void;
success: (message: string) => void;
warn: (message: string) => void;
warning: (message: string) => void;
};
number: (opts: {
defaultValue: string;
errorText: string;
initialValue: string;
message: string;
placeholder: string;
validate: (value: string) => string | void;
}) => Promise<number | symbol>;
table: (opts: {
opts: TableUserConfig;
type: PromptLineMethod;
value: TableData;
}) => void;
cancel: void;
confirm: Promise<boolean | symbol>;
group: Promise<{ [P in string | number | symbol]: PromptGroupAwaitedReturn<T>[P] }>;
groupMultiselect: Promise<symbol | Value[]>;
intro: void;
isCancel: value is symbol;
multiselect: Promise<symbol | Value[]>;
note: void;
outro: void;
password: Promise<string | symbol>;
select: Promise<symbol | Value>;
selectKey: Promise<symbol | Value>;
spinner: {
message: (msg?: string) => void;
start: (msg?: string) => void;
stop: (msg?: string, code?: number) => void;
};
tasks: Promise<void>;
text: Promise<string | symbol>;
} = _prompt;
```
Prompt functions
##### Type declaration
| Name | Type | Description |
| ------ | ------ | ------ |
| `box` | (`opts`: \{ `opts`: `Options`; `type`: `PromptLineMethod`; `value`: `string`; \}) => `void` | - |
| `columns` | (`opts`: \{ `opts`: `GlobalOptions`; `type`: `PromptLineMethod`; `value`: `ColumnData`; \}) => `void` | - |
| `log` | \{ `error`: (`message`: `string`) => `void`; `info`: (`message`: `string`) => `void`; `message`: (`message`?: `string`, `{ symbol }`?: `LogMessageOptions`) => `void`; `step`: (`message`: `string`) => `void`; `success`: (`message`: `string`) => `void`; `warn`: (`message`: `string`) => `void`; `warning`: (`message`: `string`) => `void`; \} | - |
| `log.error` | (`message`: `string`) => `void` | - |
| `log.info` | (`message`: `string`) => `void` | - |
| `log.message` | (`message`?: `string`, `{ symbol }`?: `LogMessageOptions`) => `void` | - |
| `log.step` | (`message`: `string`) => `void` | - |
| `log.success` | (`message`: `string`) => `void` | - |
| `log.warn` | (`message`: `string`) => `void` | - |
| `log.warning` | (`message`: `string`) => `void` | alias for `log.warn()`. |
| `number` | (`opts`: \{ `defaultValue`: `string`; `errorText`: `string`; `initialValue`: `string`; `message`: `string`; `placeholder`: `string`; `validate`: (`value`: `string`) => `string` \| `void`; \}) => `Promise`\<`number` \| `symbol`\> | - |
| `table` | (`opts`: \{ `opts`: `TableUserConfig`; `type`: `PromptLineMethod`; `value`: `TableData`; \}) => `void` | - |
| `cancel()` | `void` | - |
| `confirm()` | `Promise`\<`boolean` \| `symbol`\> | - |
| `group()` | `Promise`\<\{ \[P in string \| number \| symbol\]: PromptGroupAwaitedReturn\<T\>\[P\] \}\> | Define a group of prompts to be displayed and return a results of objects within the group |
| `groupMultiselect()` | `Promise`\<`symbol` \| `Value`[]\> | - |
| `intro()` | `void` | - |
| `isCancel()` | `value is symbol` | - |
| `multiselect()` | `Promise`\<`symbol` \| `Value`[]\> | - |
| `note()` | `void` | - |
| `outro()` | `void` | - |
| `password()` | `Promise`\<`string` \| `symbol`\> | - |
| `select()` | `Promise`\<`symbol` \| `Value`\> | - |
| `selectKey()` | `Promise`\<`symbol` \| `Value`\> | - |
| `spinner()` | \{ `message`: (`msg`?: `string`) => `void`; `start`: (`msg`?: `string`) => `void`; `stop`: (`msg`?: `string`, `code`?: `number`) => `void`; \} | - |
| `tasks()` | `Promise`\<`void`\> | Define a group of tasks to be executed |
| `text()` | `Promise`\<`string` \| `symbol`\> | - |
#### style
```ts
const style: {
box: (text: string, options?: Options) => string;
color: ChalkInstance;
columns: <Data>(data: Data, options?: GlobalOptions) => string;
gradient: (txt: string, colors: GradientColors, opts?: GradientOpts) => string;
line: (__namedParameters: {
align: 'center';
lineChar: '⎯';
title: string;
}) => string;
table: (data: TableData, options?: TableUserConfig) => string;
} = _style;
```
Style functions
##### Type declaration
| Name | Type |
| ------ | ------ |
| `box` | (`text`: `string`, `options`?: `Options`) => `string` |
| `color` | `ChalkInstance` |
| `columns` | \<`Data`\>(`data`: `Data`, `options`?: `GlobalOptions`) => `string` |
| `gradient` | (`txt`: `string`, `colors`: `GradientColors`, `opts`?: `GradientOpts`) => `string` |
| `line` | (`__namedParameters`: \{ `align`: `'center'`; `lineChar`: `'⎯'`; `title`: `string`; \}) => `string` |
| `table` | (`data`: `TableData`, `options`?: `TableUserConfig`) => `string` |
#### sys
```ts
const sys: __module = _sys;
```
System functions
#### TEXT\_EDITOR
```ts
const TEXT_EDITOR: {
NONE: 'none';
SUBLIME: 'subl';
VSCODE: 'code';
WEBSTORM: 'webstorm';
};
```
Text editor values used in `openEditor` option.
##### Type declaration
| Name | Type | Default value |
| ------ | ------ | ------ |
| `NONE` | `"none"` | 'none' |
| `SUBLIME` | `"subl"` | 'subl' |
| `VSCODE` | `"code"` | 'code' |
| `WEBSTORM` | `"webstorm"` | 'webstorm' |
## 👨‍💻 Development

@@ -1511,3 +72,3 @@

[![Pull requests](https://img.shields.io/badge/Pulls-grey?style=for-the-badge)](https://github.com/pigeonposse/creatium/pulls)
[![Read more](https://img.shields.io/badge/Read%20more-grey?style=for-the-badge)](https://github.com/pigeonposse/creatium)
[![Read more](https://img.shields.io/badge/Read%20more-grey?style=for-the-badge)](https://creatium.pigeonposse.com)

@@ -1532,3 +93,3 @@ ## ☕ Donate

***
---

@@ -1538,8 +99,6 @@ [![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com)

[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge&logoColor=white)](https://pigeonposse.com/?popup=donate)
[![Github](https://img.shields.io/badge/Github-black?style=for-the-badge&logo=github&logoColor=white)](https://github.com/pigeonposse)
[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/pigeonposse_)
[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/pigeon.posse/)
[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@pigeonposse)
[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logoColor=white&logo=twitter)](https://twitter.com/pigeonposse_)
[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logoColor=white&logo=instagram)](https://www.instagram.com/pigeon.posse/)
[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logoColor=white&logo=medium)](https://medium.com/@pigeonposse)
<!--

@@ -1568,9 +127,7 @@

Author: Angelo
- Author: [Angelo](https://github.com/angelespejo)
-->
-->
<!-- AUTOGEN BY DOVENV - END -->
dist/main.mjs

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc