Skip to content

rpg-sage-creative/git-utils

Repository files navigation

rpg-sage-creative/git-utils

This repo is a utils collection for RSC projects. It's purpose is simply to provide reusable code.

This repo uses node:child_process to run various git related commands against a given repo.

Node

Due to some new RegExp features implemented, this (and thus all RPG Sage Creative projects) requires Node 24.

Scripts

Included in this repo are scripts for building a repo, releasing a repo (creating a git tag), and testing a repo. Projects that depend on this repo for these features can see https://github.com/rpg-sage-creative/utils-template for how to implement them.

One of the actions performed by the build script is to create an index.ts file in each descendant of /src. These index.ts files are simply a collection of export * from ""; for each .ts file in the folder. Folders named "internal" will be excluded from these index.ts folders, but they will have their own index.ts folder created.

Notes about tsdoc / jsdoc

The build scripts included in this repo perform a dual pass build. One builds everything with an entire tsdoc. The second redoes the tsdoc files to remove any documentation with @internal in the description.

v1.?.0

As of vX.Y.Z this repo assumes you are using pnpm (instead of npm) and that you are making use of the updated v1.3.1 version of dev-scripts (and other rpg-sage-creative repos).

About

No description, website, or topics provided.

Resources

License

LGPL-3.0, GPL-3.0 licenses found

Licenses found

LGPL-3.0
COPYING.LESSER
GPL-3.0
COPYING

Stars

Watchers

Forks

Packages

 
 
 

Contributors