https://github.com/transloadit/monolib
:house_with_garden: A monorepo with publicly published TypeScript utils that we can re-use in our different projects. Not recommended for use outside Transloadit. No SemVer guarantees. Use at own Risk.
https://github.com/transloadit/monolib
Last synced: 1 day ago
JSON representation
:house_with_garden: A monorepo with publicly published TypeScript utils that we can re-use in our different projects. Not recommended for use outside Transloadit. No SemVer guarantees. Use at own Risk.
- Host: GitHub
- URL: https://github.com/transloadit/monolib
- Owner: transloadit
- License: agpl-3.0
- Created: 2020-02-17T12:28:01.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T10:21:59.000Z (10 months ago)
- Last Synced: 2025-03-24T01:25:34.989Z (10 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/org/transloadit
- Size: 1.92 MB
- Stars: 7
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# :house_with_garden: monolib
An internal monorepo with publicly published single-file TypeScript utils that we can re-use across our different projects.
It's the home to many small functions that just don't belong.
For example, Uppy has its own way of reporting bytes. We moved that function here, so now we can easily add it to our node-sdk, API, and content repo where React would be outputting bytes in /c/.
Modules are public so they can be re-used without configuring registries and setting tokens for anybody consuming them. This allows the modules to be used in e.g. Uppy or the Node SDK.
While the world _can_ consume the modules, this is mostly to make life easier for us, we won't encourage people to use these modules in their own projects. We may break SemVer with no regard to external projects. Hence, the license is AGPL-3.0-only, and we add unwelcoming READMEs with disclaimers to the modules.
## Rules
- Bundle a test with your function
- Pure functions only please
## Examples
| Module | Example | Result |
| :--------------------------------- | :--------------------------------------------------------------------------- | :-------------------------------------------------------------------------- |
| `@transloadit/abbr` | `abbr('Lorem ipsum dolor sit amet', 10, ' .. '))` | `'Lor .. met'` |
| `@transloadit/analyze-step` | `analyzeStep({ robot: '/image/resize', width: '75', height: '75' }, ROBOTS)` | `'Resize images to 75×75'` |
| `@transloadit/file-exists` | `await fileExists('foo.jpg')` | `true` |
| `@transloadit/format-duration-ms` | `formatDurationMs(10000000)` | `'2h46m40s'` |
| `@transloadit/post` | `$ post [subdir]` | Asks questions and creates a markdown post, by default in subdir `./_posts` |
| `@transloadit/pr` | `pr({ a: 1 })` | Dumps `{a: 1}` on the console, used for debugging |
| `@transloadit/prd` | `prd({ a: 1 })` | Dumps `{a: 1}` on the console and exits program, used for debugging |
| `@transloadit/prettier-bytes` | `prettierBytes(235555520)` | `'225 MB'` |
| `@transloadit/slugify` | `slugify('--This is My App !~')` | `'this-is-my-app'` |
| `@transloadit/sort-object` | `sortObject({b: 'a', a: 'b'})` | `{a: 'b', b: 'a'}` |
| `@transloadit/sort-object-by-prio` | `sortObjectByPrio({b: 'a', a: 'b'}, {_: ['b']})` | `{b: 'a', a: 'b'}` |
| `@transloadit/sort-assembly` | `sortAssembly(ASSEMBLY_OBJECT)` | Sorted Assembly Object |
| `@transloadit/sort-result-meta` | `sortResultMeta(ASSEMBLY_RESULT_META_OBJECT)` | Sorted Assembly Object |
| `@transloadit/sort-result` | `sortResult(ASSEMBLY_RESULT_OBJECT)` | Sorted Assembly Object |
Check .
## How to consume these functions?
In your project, type:
```bash
# yarn
yarn add @transloadit/analyze-step
# npm
npm i @transloadit/analyze-step --save-exact
```
## How to check out this repo locally?
```bash
cd code
git clone git@github.com:transloadit/monolib.git
cd monolib
git pull
yarn
```
## How to add functions?
- Easiest is to duplicate `./template-package` to a directory in `./packages/` and replace any `replace-me` or `replaceMe` respectively)
- Add it to the `tsconfig.json` file
- Traverse into `./packages//` and `yarn add` whichever dependency you need like you would normally
- Write your function & test (`yarn test:watch`)
- Add an example to the table in this `README.md`
- Create a changeset to document your changes (`yarn changeset`)
- Commit and push your changes
## How to run tests?
```bash
# yarn
yarn test:watch
```
## How do I publish these packages?
First make your changes and push them to the repository. We use Changesets to manage versions and changelogs.
1. Create a changeset for your changes:
```bash
yarn changeset
```
2. Push your changes and changeset files to the repository.
3. When ready to release:
- A GitHub Action will automatically create a PR with all version updates
- Once merged to main, it will automatically publish to npm
To publish manually:
1. Make sure you have push rights for the `main` branch of this repository
2. Log in to the NPM registry:
```bash
npm login
```
3. Create versions and changelogs:
```bash
yarn version
```
4. Build and publish:
```bash
yarn release
```
## How to iterate quickly inside a consuming project without publishing 100 versions?
```bash
$ cd ~/code/monolib/packages/analyze-step
$ yarn link
yarn link v1.22.4
success Registered "@transloadit/analyze-step".
info You can now run `yarn link "@transloadit/analyze-step"` in the projects where you want to use this package and it will be used instead.
Done in 0.04s.
$ cd ~/code/content
$ yarn link @transloadit/analyze-step
yarn link v1.22.4
success Using linked package for "@transloadit/analyze-step".
Done in 0.04s.
```