next-butler 1.0.1

A tool to help you delevop your Next.js project easier and faster.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# next-butler

## Instalation
```cargo install next-butler```

## File creation with the `new` command
```nb new [page|style|component] <name>```

Creates a new page, style or component file in it's corresponding folder.  
Eg.: `nb new page /users/index` creates the file index.jsx in the folder /pages/users

> [!NOTE]
> The router where pages will be created can be defined using the `--app-router` or
`--page-router` options, or defining it in the [config file](#config-file)

> [!NOTE]
> To define what extension you want the file to have or any other configuration, you
must specify it in the [config file](#config-file)

## Custom templates
You can define your own custom templates by creating them inside
`nextbutler/templates/[pages|stylesheets|components]/`.
The file extension can also be set by the template, by following this naming:
`<name>[.<extension>].hbs`

#### Example of a page template
```typescript
// nextbutler/templates/pages/example_tmpl.tsx.hbs

export default function {{ name }}() {
    return <h1>Welcome!</h1>
}
```
This template file will produce the following file when running (notice we omit the .hbs extension):
```
nb new page /home-page --template example_tmpl.tsx
```
```typescript
export default function HomePage() {
    return <h1>Welcome!</h1>
}
```

> [!NOTE]
> You can omit the extension when running the command if there is not another
template with the same name

## Config file
The config file, `nextbutler/nextbutler.json`, must contain objects defining
the custom behaviour of the commands.  
Below are all the possible options with it's corresponding default value:

    {
        new: {
            page: {
                typescript: false // Create files as .ts files?
                jsx: true // Create files as .tsx or .jsx
                template: null // Which template to use by default
                api_template: null // Which template to use by default for api routes
                page_router: false // Create page based on the old page router
            },
            style: {
                extension: 'css' // If the file has to have the .scss extension
                folder: "styles" // Where the stylesheets should be created
                template: null // Which template to use by default
            },
            component {
                typescript: false // Create files as .ts files
                jsx: true // Create files as .tsx or .jsx
                folder: "components" // Where the components should be created
                template: null // Which template to use by default 
            }
        }
    }

## Initial configuration
You can create all the configuration files (with the default setup) running this command:
```
nb init
```
This will do the following:
- Create the tool's directory (nextbutler) inside the root dir
- Create the configuration file (nextbutler/nextbutler.json)
- Create the default templates as custom ones