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

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

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

• Separate test by packages
• Use real typescript app for core package
• Use create react app for testing react package

https://www.gatsbyjs.com/plugins/gatsby-plugin-testing/#set-up-jest

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:

1. In a fresh monorepo package
2. Run yarn install @ts-dev-tools/react
3. Run yarn ts-dev-tools
4. 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]

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

Nextjs have it's own file strucuture, and dev deps, it aims to have a dedicated package

Describe the solution you'd like

Manage pages and lib directories for tests and lint config

https://nextjs.org/docs/basic-features/eslint#migrating-existing-config

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

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.

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

• Instead of hardcoding yarn, use current package manager (npm or yarn)

Tracking issue for:

• https://github.com/escemi-tech/ts-dev-tools/security/code-scanning/3

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"}'