escemi-tech / ts-dev-tools Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 8.49 MB

Opinionated and advisable packages to configure tools to develop a Typescript project

Home Page: https://escemi-tech.github.io/ts-dev-tools/

License: MIT License

JavaScript 1.27% TypeScript 98.73%

developer-tools eslint prettier husky type typescript jest hooks commit-lint

ts-dev-tools's Introduction

Welcome to ts-dev-tools 🛠️

Opinionated and advisable packages to configure tools to develop a Typescript project

Why ts-dev-tools ?

1. Aims to provide a first-class developper experience

Install ts-dev-tools and your project is dev ready, no more installation or setup, it just works

2. A fine tuned collection of tools and configuration ready for a realworld project

Within the dozen of existing packages, ts-dev-tools uses a short list of consistent libraries and their recommanded configuration. ts-dev-tools is used by various real world projects to be run in production, so its toolset is effective and meets industry standards.

3. Stable and secure

For every changes and dependency update, ts-dev-tools is:

Unit & E2E tested: coverage report
Audited for known vulnerabilities with CodeQL

3. One package to rule them all, one dependency to keep up to date

Dependencies are updated all weeks in order to keep dev tools up to date agains security issues and to give access to the latest available feature.

Using ts-dev-tools you should just have to update it and you'll have all the dev dependencies used by ts-dev-tools, up to date !

Usage

1. Choose the plugin that fits with you need

Name	Description
@ts-dev-tools/core	Common Typescript tools (Eslint and prettier, lint-staged and pretty-quick)
@ts-dev-tools/react	Dev tools for a for ReactJS project

2. Install

Example with plugin @ts-dev-tools/core, replace @ts-dev-tools/core by the plugin you want to use

npm install --include=dev @ts-dev-tools/core

yarn add --dev @ts-dev-tools/core

3. Enable ts-dev-tools

npx ts-dev-tools install

yarn ts-dev-tools install

⚠️ If your package is not private and you're publishing it on a registry like npmjs.com, you need to disable postinstall script using pinst. Otherwise, postinstall will run when someone installs your package and result in an error.

Author

👤 Escemi [email protected]

Website: https://www.escemi.com
LinkedIn: @escemi

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide and Contributor Code of Conduct.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

ts-dev-tools's People

Contributors

Stargazers

Watchers

ts-dev-tools's Issues

This is a workaround for having workflow actions. See https://github.com/orgs/co...

https://api.github.com/escemi-tech/ts-dev-tools/blob/86fff4cfdbdcd502ed98eda99961595fac09ed1f/.github/workflows/__shared-ci.yml#L8

name: Shared - Continuous Integration for common tasks

on:
  workflow_call:

jobs:
  continuous-integration:
    # FIXME: This is a workaround for having workflow actions. See https://github.com/orgs/community/discussions/38659
    permissions:
      id-token: write
      contents: read
      security-events: write
    uses: hoverkraft-tech/ci-github-nodejs/.github/workflows/[email protected]
    with:
      build: '{"artifact":"packages/*/dist"}'

Warn if project is requiring a dependency already required by ts-dev-tools

Is your feature request related to a problem? Please describe.

On install ts-dev-tools should parse project dev dependencies and check that they are not duplicates with the dependencies required by ts-dev-tools

If they are some, warn the user in console

ts-dev-tools is not available when @ts-dev-tools/react is installed in a monorepo package

Describe the bug

ts-dev-tools does not exist in monorepo package node_module/bin directory
It works when installing @ts-dev-tools/core

To Reproduce
Steps to reproduce the behavior:

In a fresh monorepo package
Run yarn install @ts-dev-tools/react
Run yarn ts-dev-tools
See error error Command "ts-dev-tools" not found.

Expected behavior

Should execute ts-dev-tools bin:

$ /home/test/monorepo-project/packages/test/node_modules/.bin/ts-dev-tools
Usage
    ts-dev-tools install [path from project root]

Add typescript as dev dependency

Is your feature request related to a problem? Please describe.

Add typescript as dev dependency so projects using ts-dev-tools will not have to require it anymore

Supports monorepo

For yarn workspaces: yarn add must have -W for root packages

Support @commitlint/config-nx-scopes if project is using nx

Is your feature request related to a problem? Please describe.
Yes, the problem arises when working in projects that utilize NX (Nrwl Extensions). Currently, if @commitlint/config-nx-scopes is not included in the commitlint configuration of an NX project, developers might face inconsistencies and missed scope validations, leading to less disciplined commit messages. This can disrupt project tracking and clarity, particularly in larger teams.

Describe the solution you'd like
I would like the system to automatically check if a project is using NX and if so, integrate @commitlint/config-nx-scopes into the commitlint configuration. This would ensure that all NX scopes are validated correctly, improving commit message quality and compliance with project conventions.

Describe alternatives you've considered
An alternative would be to manually update each NX project's commitlint configuration to include @commitlint/config-nx-scopes. However, this manual step is prone to human error and might be overlooked in large teams or multiple project environments.

Additional context
This integration should include a dynamic package installation feature where, if the project is identified as using NX, @commitlint/config-nx-scopes would be automatically installed and configured. This could be a part of the initial setup or a dedicated script that runs checks and updates configurations accordingly. Here is a link to the official documentation which might be helpful in understanding the scope and usage of @commitlint/config-nx-scopes: commitlint config-nx-scopes documentation.

TODO:

The system should verify if NX is installed in the project. If so, it should automatically add @commitlint/config-nx-scopes to the commitlint configuration.
It must be capable of dynamically installing packages: if the project is confirmed to be using NX, it should automatically install @commitlint/config-nx-scopes.