Skip to content

Latest commit

 

History

History
232 lines (175 loc) · 5.95 KB

INITIAL_SETUP_DOC.md

File metadata and controls

232 lines (175 loc) · 5.95 KB
Raw

Lerna setup documentation

npm init -y

npx lerna init

Modify Lerna.json

{
  "packages": ["packages/*"],
  "version": "0.0.0",
  "hoist": true, // Makes all dependencies on packages to be lifted up to the root so we de-dupe.
  "stream": true, // stream: Prints all the inner package logs when run.
  "bootstrap": {
    //  Prevents generating package-lock.json on all these packages.
    "npmClientArgs": ["--no-package-lock"]
  }
}

create packages with lerna CMD

npx lerna create @<scope>/<package_name> --yes

add packages dependencies

ref: https://github.com/lerna/lerna/tree/main/commands/add

lerna add @<scope>/<package_source> --scope=@<scope>/<package_target>

Add React to packages

Add React as a dev dependency to the button

npx lerna add react --dev --scope='@fitfab/button'

npx lerna add react-dom --dev --scope='@fitfab/button'

npx lerna add @types/react --dev --scope='@fitfab/button'

And add React as a peer dependency for consuming applications

npx lerna add react --peer --scope='@fitfab/button'

Add the Button package to the fitfab package (Main package)

npx lerna add @fitfab/button --scope=@fitfab/fitfab

Add builder to the other packages as a dev dependency

lerna add @fitfab/builder --dev --scope '{@fitfab/fitfab,@fitfab/button}'

Builder: compile the ts, tsx with Rollup

Add rollup, babel, etc... to builder package

npx lerna add rollup --scope=@fitfab/builder
npx lerna add @babel/core --scope=@fitfab/builder
npx lerna add @babel/preset-env --scope=@fitfab/builder
npx lerna add @babel/preset-react --scope=@fitfab/builder
npx lerna add @rollup/plugin-babel --scope=@fitfab/builder
npx lerna add @rollup/plugin-node-resolve --scope=@fitfab/builder

# add typescript preset to transpile ts to js
npx lerna add @babel/preset-typescript --scope=@fitfab/builder
# also add these peer dependencies typescript and tslib
npx lerna add typescript --peer --scope=@fitfab/builder
npx lerna add tslib --peer --scope=@fitfab/builder
# These are included in the @babel/preset-env
"@babel/proposal-class-properties"
"@babel/proposal-object-rest-spread"
# Using babel with the option [babelHelpers: "runtime"], you need to add this plugin
# https://babeljs.io/docs/en/babel-plugin-transform-runtime
npx lerna add @babel/plugin-transform-runtime --dev --scope=@fitfab/builder

Typescript setup

# This "tsconfig.json" is at the root of the monorepo
{
  "compilerOptions": {
    "target": "es6",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "esModuleInterop": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "jsx": "react",
    "types": ["node"]
  }
}
# This tsconfig.json is on every pakage and it extends the root tsconfig.json
{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "baseUrl": ".",
    "outDir": "./dist",
    "declaration": true,
    "declarationDir": "./dist"
  },
  "include": ["**/*.ts", "**/*.tsx"],
  "exclude": ["node_modules"]
}

Now you run the build CMD

npm run build

Resources about babel & Typescript:

Styled-components setup

Dependency installation:

# styled-components & types
npx lerna add styled-components --dev --scope=@fitfab/button
npx lerna add @types/styled-components --dev --scope=@fitfab/button

# Babel plugin for styled-components
npx lerna add babel-plugin-styled-components --dev --scope=@fitfab/button

# Add styled-components as peerdependencies to package.json
npx lerna add styled-components --peer --scope=@fitfab/button

add plugin to babel in the builder package

// builer.js file
 plugins: [
    "@babel/plugin-transform-runtime",
    "babel-plugin-styled-components", // styled-components plugin
  ],

ERROR: When run the build command, the following error is thrown:

"Error: 'typeOf' is not exported by ../../node_modules/react-is/index.js, imported by ../../node_modules/styled-components/dist/styled-components.esm.js"

SOLUTION: As per StackOverflow:

https://stackoverflow.com/questions/50080893/rollup-error-isvalidelementtype-is-not-exported-by-node-modules-react-is-inde

# add styled-components to the external inputOptions for rollup
external: ["react", "react-dom", /@babel\/runtime/, "styled-components"],

Setup yarn workspaces

# lerna.json
{
  "packages": ["packages/*"],
  "npmClient": "yarn",    # use yarn instead of npm
  "useWorkspaces": true,  # use workspaces
  "version": "0.1.2",
  # "hoist": true,        --hoist is not supported with --npm-client=yarn, use yarn workspaces instead
  "stream": true,
  "bootstrap": {
    "npmClientArgs": ["--no-package-lock"]
  }
}

# root package.json
{
  "name": "@fitfab/root",
  "version": "1.0.0",
  "private": true,  # Required for lerna to work
  "workspaces": [   # Enables yarn workspaces
    "packages/*"
  ],
  "description": "A library UI",
  "main": "index.js",
  ...
}

Note: after setting yarn, I could not publish to NPM.

I have to use the npx lerna publish from-git --no-verify-access command.

Storybook setup

# install storybook
npx -p @storybook/cli sb init --type react

# update .storybook/main.js to point to the packages stories.
module.exports = {
  stories: [
    "../packages/**/*.stories.mdx",
    "../packages/**/*.stories.@(js|jsx|ts|tsx)",
  ],
  addons: ["@storybook/addon-links", "@storybook/addon-essentials"],
};

Create a story in the packages folder: sample

add eslint, and other stuff to the monorepo:

https://medium.com/rewrite-tech/how-to-create-a-monorepo-with-lerna-3ed6dfec5021