Code Monkey home page Code Monkey logo

npm-catalogue's Introduction

Banner

Catalogue

A curated list of NPM packages developed by the SLIIT FOSS community


Getting started

  • Run pnpm install to install all dependencies

Test and Deploy

  • Run pnpm test to run all test suites in all packages

  • Run pnpm build to build all packages

  • Run pnpm --filter <package> test to run test suites for a particular package

  • Deployment is handled automatically by GitHub Actions when a commit is pushed to the main branch


Git commit messages

  • We follow conventional commits during our development workflow as it helps us automate our release process. More information can be found at their official documentation

  • Primary commit message prefixes for version bumping are as follows:

    - Feat! - bump major version
    - Feat  - bump minor version
    - Fix   - bump patch version
  • Refer the commitlint.config.js file for a full list of supported commit message prefixes


Disable version bumping for specific commit

  • Add the following to a commit message as follows: "--no-bump"
  git commit -m "Feat: some feature --no-bump"

Linting and Formatting

  • Run pnpm lint to lint all packages
  • Run pnpm format to format all packages

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

pnpm dlx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

pnpm dlx turbo link

npm-catalogue's People

Contributors

akalanka47000 avatar danuja01 avatar github-actions[bot] avatar laksara-007 avatar miyurugunarathna avatar mrmihi avatar thulinawickramasinghe avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

npm-catalogue's Issues

Updated release sync to use a personal access token from secrets

Issue to be addressed :-

The default GITHUB_TOKEN does have permission to bypass branch protection rules and as such requires things such as approval before commiting due to which it fails inside the runner. This can be mitigated by using a personal access token with elevated permissions.

Polyfill dependencies during build - @sliit-foss/babel-plugin-transform-trace

Currently @sliit-foss/functions needs to be installed separately in the client project for the build to work smoothly if using package managers like PNPM due to hoisting. This can be avoided if the required functions can be polyfilled in during the build process.

I'm not really sure of where to start on this, will have to inspect existing plugins which provide polyfills to get an idea on this

Annotation based tracing - @sliit-foss/babel-plugin-transform-trace

Requirement :- As a developer, rather than ignoring the functions which I do not need tracing for by specifying them in the babel config, it would be much more feasible to mark only those which needs to be traced with an annotation in the source code.

Example solution :-

@timekeeper
const foo = () => {
  console.log("Inside foo");
}

Note:- decorators are not natively supported in JavaScript, a plugin such as @babel/plugin-proposal-decorators will need to be incorporated

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.