Code Monkey home page Code Monkey logo

javascript's Introduction

Planning Center JavaScript

A collection of shared components, scripts, wrappers, and forks in JavaScript.

Packages

Structure

planningcenter/javascript is a single repository with many independent, linked NPM packages. This is frequently referred to as a Monorepo. Projects like babel and react use this structure to manage related but independent packages.

Keeping these independent projects in one repository has one destinct advantage: included packages can be linked for local, cross-package development.

Here's an example...

Say you're working in @planningcenter/topbar and need to add a feature to @planningcenter/url. Instead of having find that repo, clone it,, make a few blind change, publish, and re-yarn, you're able to develop and publish changes to both simultaniously.

Publishing

Lerna manages publishing at the root of the project. This is big conceptual differenceMono form 1:1 package:repo projects.

A typical workflow looks like this:

  • Navigate to your project in the /packages directory
  • Develop using the scripts setup there
  • Navigate back to the root and run yarn lerna publish
  • Follow the the prompts to select a new version appropriate for your changes

Here are additional commands you might find helpful:

Command Description
yarn lerna ls List packages
yarn lerna diff Diff all packages against the last release
yarn lerna diff [pkg-name] Diff a single package against the last release.
yarn lerna publish Publish all packages
yarn lerna help See all the other cool things you can do

NOTE

All commands are prefixed with yarn. npm is not an acceptable substitute for lerna commands.

Improvements

  • New project generator with sensible defaults

javascript's People

Contributors

chantastic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.