Skip to content

chore: housekeeping, bump all (dev) deps #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2025
Merged

Conversation

JounQin
Copy link
Member

@JounQin JounQin commented Apr 1, 2025

close #200

Summary by CodeRabbit

  • New Features
    • Introduced automated workflows for code formatting, security scanning, package size reporting, and release management.
  • Improvements
    • Enhanced the command line interface and modular functionality for a more intuitive and reliable user experience.
    • Upgraded dependency management and testing processes to ensure consistent builds.
  • Chores
    • Refined project configurations for code style, linting, and build processes, resulting in improved maintainability and overall stability.

Copy link

changeset-bot bot commented Apr 1, 2025

⚠️ No Changeset found

Latest commit: 9ff13fd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@JounQin JounQin requested a review from Copilot April 1, 2025 06:10
Copy link

coderabbitai bot commented Apr 1, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates various configuration files, workflows, and source modules. New configuration files (e.g., .editorconfig, .yarnrc.yml) establish coding styles, dependency management, and testing parameters. Multiple GitHub Actions workflows have been added or modified to automate autofixes, CI builds, security analysis, package publication, size reporting, and release processes. The linting configurations have been streamlined by replacing and removing legacy files, and the source code has been refactored to improve import paths, asynchronous handling, and modularity. Package metadata and TypeScript settings were updated to reflect dependency version increments and new export formats.

Changes

Files Change Summary
.editorconfig, .eslintignore, .eslintrc, src/.eslintrc, .lintstagedrc.cjs, .lintstagedrc.js, .simple-git-hooks.cjs, .simple-git-hooks.js, eslint.config.js, .prettierignore Introduced a new .editorconfig; removed legacy ESLint, lint-staged, and Git hook CJS files; added updated JS configuration files; and modified .prettierignore to exclude .yarn.
.github/workflows/autofix.yml, ci.yml, codeql.yml, pkg-pr-new.yml, pkg-size.yml, release.yml, size-limit.yml Added new workflows and updated existing ones to automate autofix, continuous integration (with expanded Node.js matrix), CodeQL analysis, package publishing, package size reporting, and release processes with enhanced concurrency and permissions.
package.json, tsconfig.json, .renovaterc, .yarnrc.yml, vitest.config.ts, .size-limit.json Updated package metadata including repository URL, export formats, and dependency versions; revised TypeScript and Renovate configurations; and introduced new Yarn and testing configuration files.
src/api.ts, cli.ts, comment.ts, env.ts, get-changed-packages.ts, index.ts, main.ts, run.ts, types.ts, utils.ts, global.d.ts, index.d.cts; test/utils.spec.ts Refactored source modules to improve modularity, update import paths, enhance asynchronous file handling, modify regex usage, and reorganize exports. Test import paths were also updated.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Function Caller
    participant API as createApi Function
    participant Env as Environment Variables
    participant Client as GitLab API Client
    Caller->>API: Call createApi(optionalToken)
    API->>Env: Check and apply proxy settings
    API->>Env: Retrieve GitLab token and GITLAB_TOKEN_TYPE
    alt Token is OAuth
        API->>Client: Initialize client with OAuth token
    else Standard Token
        API->>Client: Initialize client with standard token
    end
    API->>Caller: Return GitLab API Client
Loading

Assessment against linked issues

Objective Addressed Explanation
Update dependency @changesets/read to ^0.6.2 (#200)

Poem

I’m a bunny coding with glee,
Hopping through workflows and config spree,
New files bloom and old ones fade,
In the garden of code, a fresh path is laid.
With async hops and modular cheer,
Our project leaps to a bright new year!
🌸🐇 Happy coding!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

.lintstagedrc.js

Oops! Something went wrong! :(

ESLint: 9.23.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

eslint.config.js

Oops! Something went wrong! :(

ESLint: 9.23.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

.simple-git-hooks.js

Oops! Something went wrong! :(

ESLint: 9.23.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

  • 14 others

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1276718 and 9ff13fd.

⛔ Files ignored due to path filters (4)
  • .yarn/plugins/plugin-prepare-lifecycle.cjs is excluded by !**/.yarn/**
  • .yarn/releases/yarn-4.8.1.cjs is excluded by !**/.yarn/**
  • test/__snapshots__/utils.spec.ts.snap is excluded by !**/*.snap
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (37)
  • .editorconfig (1 hunks)
  • .eslintignore (0 hunks)
  • .eslintrc (0 hunks)
  • .github/workflows/autofix.yml (1 hunks)
  • .github/workflows/ci.yml (2 hunks)
  • .github/workflows/codeql.yml (1 hunks)
  • .github/workflows/pkg-pr-new.yml (1 hunks)
  • .github/workflows/pkg-size.yml (1 hunks)
  • .github/workflows/release.yml (3 hunks)
  • .github/workflows/size-limit.yml (1 hunks)
  • .gitignore (1 hunks)
  • .lintstagedrc.cjs (0 hunks)
  • .lintstagedrc.js (1 hunks)
  • .prettierignore (1 hunks)
  • .renovaterc (1 hunks)
  • .simple-git-hooks.cjs (0 hunks)
  • .simple-git-hooks.js (1 hunks)
  • .size-limit.json (1 hunks)
  • .yarnrc.yml (1 hunks)
  • eslint.config.js (1 hunks)
  • global.d.ts (1 hunks)
  • index.d.cts (1 hunks)
  • package.json (1 hunks)
  • src/.eslintrc (0 hunks)
  • src/api.ts (1 hunks)
  • src/cli.ts (2 hunks)
  • src/comment.ts (4 hunks)
  • src/env.ts (2 hunks)
  • src/get-changed-packages.ts (4 hunks)
  • src/index.ts (1 hunks)
  • src/main.ts (3 hunks)
  • src/run.ts (3 hunks)
  • src/types.ts (1 hunks)
  • src/utils.ts (4 hunks)
  • test/utils.spec.ts (1 hunks)
  • tsconfig.json (1 hunks)
  • vitest.config.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

socket-security bot commented Apr 1, 2025

Report too large to display inline

View full report↗︎

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR performs housekeeping by bumping various development dependencies and updating configuration files and workflows. The changes include updating ESLint and lint-staged configurations, configuring new GitHub workflows for CI, release, package size reporting, CodeQL analysis, and autofix.

Reviewed Changes

Copilot reviewed 35 out of 41 changed files in this pull request and generated no comments.

Show a summary per file
File Description
eslint.config.js Exports the updated ESLint configuration
.yarnrc.yml Specifies Yarn settings including telemetry and plugins
.yarn/plugins/plugin-prepare-lifecycle.cjs Introduces a Yarn plugin for prepare lifecycle
.simple-git-hooks.js & .simple-git-hooks.cjs Updates module export strategy for git hooks
.lintstagedrc.js & .lintstagedrc.cjs Updates module export strategy for lint-staged
Various .github/workflows/*.yml Adds and updates CI and release workflows
Files not reviewed (6)
  • .editorconfig: Language not supported
  • .eslintignore: Language not supported
  • .eslintrc: Language not supported
  • .prettierignore: Language not supported
  • .renovaterc: Language not supported
  • .size-limit.json: Language not supported
Comments suppressed due to low confidence (2)

.github/workflows/codeql.yml:48

  • The leading slash in the category value may be unintentional. Please verify whether the category should be formatted without the leading slash.
          category: '/language:${{ matrix.language }}'

.github/workflows/ci.yml:31

  • Ensure that the project includes the 'npm-run-all' dependency to support the 'yarn run-s' command used to run multiple scripts concurrently.
        run: yarn run-s build lint test

Copy link

codesandbox-ci bot commented Apr 1, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@JounQin JounQin force-pushed the chore/housekeeping branch from 36cc20d to 626e587 Compare April 1, 2025 06:12
Copy link

pkg-pr-new bot commented Apr 1, 2025

Open in StackBlitz

npm i https://pkg.pr.new/un-ts/changesets-gitlab@207

commit: 9ff13fd

Copy link
Contributor

github-actions bot commented Apr 1, 2025

📊 Package size report   40%↑

File Before After
index.d.cts 73 B
lib/api.d.ts 99 B
lib/api.js 899 B
lib/api.js.map 1.0 kB
lib/cli.js 878 B -16.4%↓734 B
lib/cli.js.map 1.1 kB -14%↓932 B
lib/comment.d.ts 425 B -7.06%↓395 B
lib/comment.js 8.8 kB -0.03%↓8.8 kB
lib/env.d.ts 67 B 4%↑70 B
lib/get-changed-packages.js 4.9 kB -1.9%↓4.8 kB
lib/get-changed-packages.js.map 4.8 kB -2.2%↓4.7 kB
lib/git-utils.d.ts 584 B
lib/git-utils.js 1.6 kB
lib/git-utils.js.map 2.0 kB
lib/gitUtils.d.ts 596 B
lib/gitUtils.js 1.6 kB
lib/gitUtils.js.map 2.0 kB
lib/index.cjs 2.6 kB 1,360%↑38.3 kB
lib/index.d.ts 255 B 7%↑274 B
lib/index.js 783 B -69.2%↓241 B
lib/index.js.map 922 B -73%↓249 B
lib/main.js 3.6 kB 0.3%↑3.6 kB
lib/main.js.map 3.1 kB 0.6%↑3.1 kB
lib/read-changeset-state.d.ts 252 B
lib/read-changeset-state.js 724 B
lib/read-changeset-state.js.map 830 B
lib/readChangesetState.d.ts 252 B
lib/readChangesetState.js 722 B
lib/readChangesetState.js.map 826 B
lib/run.js 8.4 kB -1.23%↓8.3 kB
lib/run.js.map 7.6 kB -1.94%↓7.5 kB
lib/utils.d.ts 1.4 kB 3%↑1.4 kB
lib/utils.js 3.9 kB 4%↑4.1 kB
lib/utils.js.map 4.4 kB 4%↑4.5 kB
package.json 2.9 kB 8%↑3.2 kB
Total (Includes all files) 90.7 kB 40%↑127.2 kB
Tarball size 25.0 kB 29%↑32.2 kB
Unchanged files
File Size
lib/cli.d.ts 39 B
lib/comment.js.map 6.9 kB
lib/context.d.ts 74 B
lib/context.js 138 B
lib/context.js.map 228 B
lib/env.js 934 B
lib/env.js.map 833 B
lib/get-changed-packages.d.ts 305 B
lib/main.d.ts 153 B
lib/run.d.ts 870 B
lib/types.d.ts 1.1 kB
lib/types.js 44 B
lib/types.js.map 102 B
LICENSE 1.1 kB
README.md 11.0 kB

🤖 This report was automatically generated by pkg-size-action

@JounQin JounQin force-pushed the chore/housekeeping branch from 626e587 to a22c455 Compare April 1, 2025 06:14
@JounQin JounQin force-pushed the chore/housekeeping branch from a22c455 to 9ff13fd Compare April 1, 2025 06:15
Copy link

sonarqubecloud bot commented Apr 1, 2025

@JounQin JounQin merged commit 9edcfd9 into main Apr 1, 2025
18 checks passed
@JounQin JounQin deleted the chore/housekeeping branch April 1, 2025 06:18
JounQin added a commit that referenced this pull request Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant