Skip to content

Kalisio's meta-repo for sharing tools, configurations, and conventions

License

Notifications You must be signed in to change notification settings

kalisio/meta-ekosystem

Repository files navigation

meta-ekosystem

Latest Release Download Status License: MIT

Kalisio's meta-repo for sharing tools, configurations, and conventions


This repository centralizes common development resources used across Kalisio projects, including:

  • A meta package catalog for ecosystem management
  • Various scripts to be included in monorepo projects that includes this meta-repo
  • Various code genertors to help creating monorepo projects
  • Common conventions

Important

Before getting started, make sure you have the following prerequisites installed:

Usage

This repository is designed to be included as a development dependency in your monorepo, providing access to the different shared resources.

Installation

pnpm add -D @kalisio/meta-ekosystem

Catalog

The catalog.json file, also referred to as the meta-catalog, centralizes and maintains the list of all dependencies, along with their respective versions, to ensure consistency and alignment across the Kalisio ecosystem.

Tip

Use the k-sync-catalog commands to keep your local catalog synchronized with this meta-catalog.

Commands

The commands are intended to be used by monorepo projects that depend on this repository.

Tip

To run a command from this repository, use: node ./bin/<command>

k-init-docs

  • Description

It generates a VitePress skeleton in a docs/ directory with the following structure:

docs
├── about
│   ├── contact.md
│   ├── contributing.md
│   ├── introduction.md
│   └── license.md
├── index.md
└── .vitepress
    ├── config.mjs
    └── theme
        ├── custom.css
        └── index.js
  • Usage
pnpm k-init-docs

k-init-monorepo

  • Description

It generates a monorepo skeleton with the following structure:

monorepo
├── CONTRIBUTING.md
├── .gitignore
├── .husky
│   └── pre-commit
├── LICENSE.md
├── package.json
├── pnpm-workspace.yaml
├── README.md
├── sonar-project.properties
├── vite.config.js
└── vitest.config.js
  • Usage
pnpm k-init-monorepo

Note

You will be prompted for the repository name and path.

k-init-pacakge

  • Description

It generates a package skeleton with the following structure:

package
├── LICENSE.md
├── package.json
├── README.md
└── vite.config.js
  • Usage
pnpm k-init-package

Note

You will be prompted for the pacakge name and description.

k-gen-docs

It generates VitePress-compatible Markdown documentation from JSDoc comments by scanning monorepo packages and rendering them with a Handlebars template into a docs/ directory.

  • Usage
pnpm k-gen-docs

k-sync-catalog

  • Description

It synchronizes your project catalog by merging the meta-catalog with an existing local catalog file and updating the catalog property in pnpm-workspace.yaml.

k-sync-catalog
  • Usage
pnpm k-sync-catalog

Contributing

Guidelines

Found a bug ? Missing a feature ? Want to contribute ? Please refer to our contribution guidelines for details.

Development

Setup

# Clone the repository
git clone https://github.com/kalisio/meta-ekosystem.git
cd meta-ekosystem

# Install dependencies
pnpm install

Local linking

This repository provides global binaries to help manage the monorepo ecosystem. During development, you will often need to link this package to other projects to test the features you are working on.

If you're working on multiple packages simultaneously:

# In the meta-ekosystem directory
pnpm link --global

# In your project directory
pnpm link --global @kalisio/meta-ekosystem

Or for a direct local link:

# In your project directory
pnpm link ../path/to/meta-ekosystem

To stop linking a local version and switch back to the published version:

# In your project directory
pnpm unlink @kalisio/meta-ekosystem

Linting

# In the meta-ekosystem directory
pnpm lint

Note

This repository follows the standardJS style guide for linting and code consistency. By default, standard is called with the --fix option to automatically fix style issues before committing.

License

Licensed under the MIT License.

Copyright (c) 2026 Kalisio

Kalisio

About

Kalisio's meta-repo for sharing tools, configurations, and conventions

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors