connectme-sdk v1.10.0

SCP SDK

📖 Usage And Documentation 📖

Developer Documentation

Install Yarn

sudo npm install --global yarn

Install dependencies

yarn

This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM.

If you’re new to TypeScript, checkout this handy cheatsheet

Commands

TSDX scaffolds your new library inside /src.

To run TSDX, use:

yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use bun run build.

To run tests, use bun run test or bun run test.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Bundle Analysis

size-limit is set up to calculate the real cost of your library with yarn size and visualize the bundle with yarn analyze.

Setup Files

This is the folder structure we set up for you:

/src
  index.tsx       # EDIT THIS
/test
  blah.test.tsx   # EDIT THIS
.gitignore
package.json
README.md         # EDIT THIS
tsconfig.json

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean

// inside your code...
if (__DEV__) {
  console.log('foo')
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.

Including Styles

There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.

For vanilla CSS, you can include it at the root directory and add it to the files section in your package.json, so that it can be imported separately by your users and run through their bundler's loader.

Publishing to NPM

Using gitlab ci

1. Go to 'master' branch
2. Update app version in package.json
3. Put the same version in 'src/version.ts'
4. Push your code
5. Go to connect-sdk repo
6. Create a tag with the same version used previously
7. Wait the pipeline to finish
8. Run the manual job 'publish_npm'
9. check connect-sdk when done

Using np

You can find NPM_TOKEN in Gitlab varible section

Put NPM_TOKEN in env. variables. We recommend using np.

check connect-sdk when done

Manual publish to NPM

You can find NPM_TOKEN in Gitlab varible section

1. Go to 'master' branch
2. Update app version in package.json
3. Put the same version in 'src/version.ts'
4. Push your code

echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}">.npmrc
yarn publish --access public # Publish the package to npm

check connect-sdk when done