Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexzhang1030/effso
Effso is a tool to help you operate files and directories in a more efficient way.
https://github.com/alexzhang1030/effso
Last synced: 7 days ago
JSON representation
Effso is a tool to help you operate files and directories in a more efficient way.
- Host: GitHub
- URL: https://github.com/alexzhang1030/effso
- Owner: alexzhang1030
- License: mit
- Created: 2023-02-13T15:12:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T01:56:26.000Z (7 months ago)
- Last Synced: 2024-04-19T16:13:07.049Z (7 months ago)
- Language: TypeScript
- Size: 893 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EFFSO
English / [简体中文](./README.zh.md)
## Why
Just imagine a scene:
Every time when you init a blank project, you need to copy the same files to configure tools, you need do the same thing to every project, such as add a `.edtorconfig` file.
A starter-template? Yes, it's a very good idea, but also have some problems.
1. A starter-template cannot split the common files, such as `.editorconfig` and `.gitignore`, from the project files.
2. A starter-template is not general enough. It's hard to maintain multiple starter-templates for multiple topics(such as `TypeScript` or `Nuxt`).
3. It's a hard thing that you need to maintain a starter-template for a long time.(For example, you want to change the `.editorconfig` file, you need to update all the starter-templates.)
4. ...
So why not make it more atomic?
Effso based on the concept of atomic, it's a tool to help you operate files and directories in a more efficient way.
Effso reads user pre-defined rules, and operates files by following some ways.
## Installation
```bash
pnpm i -g effso
```
## Setup
```bash
effso setup
```
will generate a `.effso/example` directory in your home directory.
It generates some simple examples:
- `main.json`
- `.editorconfig`
- `.gitignore`
- `eslint.pkg.ts`
- `renovate.file.ts`
## Usage
### Bash
> NOTE: requires `zsh`
```bash
effso shell
```
Will inject some scripts into your `~/.zshrc` file.
This will check if the current directory has a `.effso/config.json` file when you enter a path(use `cd` or something), if it has, will execute `effso build`.
### Build
```bash
# Run in your project directory
effso build
```
Will read `./.effso/config.json` to build things from given rules.
Like:
```json
{
"extends": ["github.com/alexzhang1030/starter-ts"]
}
```
Extends things will pass to `degit` to overrides current workspace files.
Useful when you want to init a project from a starter-template.
### Run
```bash
# Run in your project directory
effso run
```
Will shows a selector, you can choose the rules you want to run.
It will read `~/.effso/*` to generate rules. One second level directory will become one option.
When you choose a rule, it will read the files in the directory, and operate current workspace files by pre-defined rules.
#### Rules
Here is my [effso rules example](https://github.com/alexzhang1030/effso-rules)
##### `main.json`
Configure current root option default selected rules.
Currently only support `JSON`. If `main.json` is not provided, will have no default selected rules.
```json
{
"default": [".gitignore", ".editorconfig", "eslint.pkg.ts"]
}
```
##### Single file
Every single file selected will overrides current workspace file.
##### \*.pkg.ts
Will execute this rule by passing current `package.json` if it exists.
Notice this file can only have one function, it's name must be `main`, and can only accept one argument.
```ts
function main(pkg: Record) {
// do something...
}
```
##### \*.file.ts
Will execute this rule by passing current workspace path.
The same as `*.pkg.ts`, this file can only have one function, it's name must be `main`, and can only accept two arguments.
```ts
function main(
path: string,
helpers: {
read: (path: string) => string
write: (path: string, content: string) => void
}
) {
// to something
}
```
You can modify the file by `helpers.read` and `helpers.write`.
You can merge object by `helpers.merge`.
For example:
```ts
function main(
path: string,
helpers: {
read: (path: string) => string
write: (path: string, content: string) => void
merge: (target: object, source: object) => object
}
) {
const target = `${path}/.github/renovate.json`
const content = helpers.read(target)
if (!content) {
write(
target,
JSON.stringify(
{
extends: ['config:base'],
},
null,
2
)
)
}
}
```