https://github.com/niieani/repo

One .config folder to rule all your configs
https://github.com/niieani/repo

Last synced: 2 months ago
JSON representation

One .config folder to rule all your configs

• Host: GitHub
• URL: https://github.com/niieani/repo
• Owner: niieani
• Created: 2023-09-28T19:34:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-28T19:37:56.000Z (about 2 years ago)
• Last Synced: 2025-08-11T05:47:46.348Z (2 months ago)
• Size: 1.95 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# project codename: repo

NOTE: the name `repo` is not final and is likely to change.

The un-template / un-boilerplate / un-scaffold / un-generator.

Keep ALL of your project's configuration files up to date, and easily override them, using a single, typed language.

Managing the JavaScript ecosystem can be a full time job.

Upgrades to transpiles, migrations across builder systems, migrating or adding support for new engines (deno, bun), correct support for CommonJS and ESM, linting, testing, etc.

And if you maintain more than one package, multiply all of that work by each one!

Annoyed by ecosystem/tooling churn? Hard to maintain dependencies? Tired of manually updating configs?

Tired of various tools having different configuration formats?

Some starting with dot, some in their own folders, some in .json,

others in .yaml, JavaScript, or even .toml?

Configure everything in TypeScript, neatly organized inside of a `.config` folder.

Additionally, reuse your configuration across projects, and easily update them all at once.

Override only the parts you need to in your given project, and keep the rest up to date.

Scaffolding seems great at first, but isn't good enough, because it's not maintainable.

The ecosystem moves too fast, and there are no configuration management tools in the JavaScript ecosystem.

`repo` fixes [this](https://twitter.com/WarrenInTheBuff/status/1672839156647575552) and [this](https://deno.com/blog/node-config-hell) and [this](https://www.youtube.com/watch?v=wYdnJPYFTIE).

`repo` is here to help out.

## Features

- Simple repo management system:

  - Immutable/reconstructable configs (nix-os philosophy)

  - Allow custom build strategy

  - Allow overrides for any config

  - Allow search and replace for any config

  - Monorepo support

  - Set build strategy (simple, e.g. library-webpack or web-vite)

  - General repo strategy (Github actions)

  - Easy migrations?

  - Config can be (should be?) in TypeScript ESM

- Tools supported:

  - node

  - bun

  - pnpm or yarn?

    - probably yarn (more features, and plugin support)

  - electron

  - react native

  - ? deno

  - ? reasonml

  - maybe [moon](https://moonrepo.dev/) or wireit?

- Functionality:

  - setup node/bun version

  - simple CLI to manage the repo

  - extendable plain files (autogenerated):

    - gitignore, npmignore, etc.

  - typescript

    - auto-project references

  - dummy config strategies (doesn't do anything, but multiple strategies can use the config)

    - target strategy (node/web/react)

    - execution strategy (cli/browser/service/none)

  - dev+build strategies

    - library-types (tsc)

    - library-esm (build + creates esm/package.json with type: "module")

    - library-cjs (build + creates cjs/package.json with type: "commonjs")

    - library-umd (webpack, single file -- needs config for globalName, optionally output file)

    - [denoland/dnt](https://twitter.com/deno_land/status/1676264059585560578?t=1rx7LS3Juh3biPdKhzLuow&s=19) for compiling maybe?

    - web-vite

    - app-electron

    - app-react-native (use Ignite? w/ expo)

  - test strategies

    - jest

    - vitest

    - benchmarking

    - pure bun test

    - pure node test runner?

    - eslint

    - rome.tools (now [biome](https://biomejs.dev/)) linting + formatter ?

  - ci strategies

    - github actions

      - conditionally creates testing + release based on other strategies

  - package release strategies

    - semantic-release / better: [auto](https://github.com/intuit/auto)

  - dependency update automation

    - renovate

    - dependabot

  - ide strategy

    - vscode

      - automatically hide all generated config files from the folder, but create symlinks in .config so they can be previewed in the IDE

  - project website/docs strategy

    - docusaurus

    - storybook

  - static hosting strategy

    - github pages

## Simple CLI to manage the repo

```shell

$ repo use test-jest test-eslint

# or use your own / customized version:

$ repo use @niieani/jest @niieani/eslint

$ repo use storybook

```