Basic template for Mono Repo

Explore the docs »
Report Bug · Request Feature

Table of Contents

• Organization
• Built With
• Getting Started
• Contributing

Built With

• yarn workspaces
• react
• nextjs
• jest
• ora
• commander
• renovate

Organization

This is organized as a Mono repo. It contains different packages that can be distributed separately:

core

this package contains the stand alone functions that power up the cli and the eslint-plugin

cli

The command line will simplify listing and pulling local and 3rd party dependencies

pull local and 3rd party dependencies

  dependency-migration pull <static/bundles/[bundleName]>

Display dependencies that will be pulled into the bundle

  dependency-migration detect <static/bundles/[bundleName]>

Pull all the local packages as dependencies

We consider local packages to

• Libraries: coursera written libraries located in js/lib
• Bundles: coursera bundleS imported within static/bundles/

    dependency-migration pull-local <static/bundles/[bundleName]>

Pull only 3rd party dependencies:

  dependency-migration pull-3rd-party <static/bundles/[bundleName]>

Add package.json to an existing dependency

If you are calling a dependency that does not have a package.json, you can fix this by running:

  dependency-migration fix-dependency-package <relative/path>

eslint-plugin

The eslint-plugin will take care of replacing imports (when use with --fix) and prevent introducing local dependencies without package.json

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request