Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tatumon/next-butler
A tool to help you delevop your Next.js project easier and faster
https://github.com/tatumon/next-butler
Last synced: about 2 months ago
JSON representation
A tool to help you delevop your Next.js project easier and faster
- Host: GitHub
- URL: https://github.com/tatumon/next-butler
- Owner: TatuMon
- Created: 2023-02-04T06:35:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T13:30:23.000Z (8 months ago)
- Last Synced: 2024-11-10T05:42:07.892Z (about 2 months ago)
- Language: Rust
- Size: 1.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# next-butler
## Instalation
```cargo install next-butler```
## File creation with the `new` command
```nb new [page|style|component] ```
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:
`[.].hbs`
#### Example of a page template
```typescript
// nextbutler/templates/pages/example_tmpl.tsx.hbs
export default function {{ name }}() {
return
Welcome!
}
```
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 Welcome!
}
```
> [!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