Skip to content
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

feature(tools): add fta #699

Merged
merged 3 commits into from
Apr 6, 2024
Merged

feature(tools): add fta #699

merged 3 commits into from
Apr 6, 2024

Conversation

Idrinth
Copy link
Member

@Idrinth Idrinth commented Apr 6, 2024

The Pull Request is ready

Overview

  • add a wrapped fta

Tools

  • the change works with both supported node versions
  • the default behaviour did not change
  • shared code has been extracted in a different file

Summary by CodeRabbit

  • New Features
    • Implemented GitHub Actions workflows for continuous integration across various projects, including CLI tools, documentation microservices, and websites.
    • Introduced a new fta script in package.json for running the File Type Analyzer (FTA) tool.
    • Added a new tool (fta.js) for assessing file types and displaying formatted results based on predefined score thresholds.

Copy link
Contributor

coderabbitai bot commented Apr 6, 2024

Warning

Rate Limit Exceeded

@Idrinth has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 43 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between a75beb4 and df7e952.

Walkthrough

The recent changes enhance the CI process across multiple projects by integrating the File Type Analyzer (FTA) tool. This addition aims to improve code quality by evaluating complexity and maintainability to ensure adherence to set standards before merging into the master branch.

Changes

Files Change Summary
.github/workflows/...fta.yml (5 files) Introduced GitHub Actions workflows for FTA checks on the master branch across various projects.
package.json, tools/fta.js, tools/src/constants.js Added fta-cli dependency, script for FTA execution, and FTA-related constants for score thresholds.

Assessment against linked issues

Objective Addressed Explanation
Add FTA for the CI (#684)

Poem

In the realm of code, where bits nimbly play,
A rabbit works tirelessly, ensuring the way.
With FTA in tow, it dances with delight,
Upholding code standards, keeping them bright.

🐇💻✨
"No bug too minor, no task too grand,
With our new tools, we'll make the code stand!"
So here's to the rabbit, for quality's new height,
In the realm of code, where excellence takes flight.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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/coderabbit-overrides.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.

@github-actions github-actions bot added component: documentation-website related to the project's website, not the framework component: framework related to the project framework, not the website component: tooling Something to help make our life easier component: history-microservice Anything related to the database access microservice component: history-website anything related to the data history display page component: cli The cli tool of api-bench research researching a specific topic to makee decisions on it labels Apr 6, 2024
tools/fta.js Dismissed Show dismissed Hide dismissed
tools/fta.js Show resolved Hide resolved
Comment on lines 1 to 47
name: history-microservice FTA
on:
push:
branches:
- master
paths:
- 'history-microservice/**.ts'
- 'history-microservice/**.tsx'
- 'history-microservice/**.js'
- 'history-microservice/**.cjs'
- 'history-microservice/**.json'
- 'history-microservice/**.svelte'
- '.github/workflows/history-microservice.fta.yml'
pull_request:
branches:
- master
paths:
- 'history-microservice/**.ts'
- 'history-microservice/**.tsx'
- 'history-microservice/**.js'
- 'history-microservice/**.cjs'
- 'history-microservice/**.json'
- 'history-microservice/**.svelte'
- '.github/workflows/history-microservice.fta.yml'
env:
PREVIOUS_NODE_VERSION: ${{ vars.PREVIOUS_NODE_VERSION || 'lts/*' }}
CURRENT_NODE_VERSION: ${{ vars.CURRENT_NODE_VERSION || 'latest' }}
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ env.CURRENT_NODE_VERSION }}
uses: actions/setup-node@v4
with:
node-version: ${{ env.CURRENT_NODE_VERSION }}
cache: 'npm'
cache-dependency-path: |
framework/package-lock.json
documentation-website/package-lock.json
history-microservice/package-lock.json
history-microservice/package-lock.json
cli/package-lock.json
package-lock.json
- run: npm ci
- run: cd history-microservice && npm ci && npm run language
- run: npm run fta -- history-microservice
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider specifying a more restrictive set of branches for triggers to avoid unnecessary runs on all branches.

  push:
    branches:
-   - master
+   - main
    paths:

This change ensures that the workflow only runs on the main branch, which is a common practice for protecting key branches in a project. If your project uses a different branch as its primary branch, adjust accordingly.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
name: history-microservice FTA
on:
push:
branches:
- master
paths:
- 'history-microservice/**.ts'
- 'history-microservice/**.tsx'
- 'history-microservice/**.js'
- 'history-microservice/**.cjs'
- 'history-microservice/**.json'
- 'history-microservice/**.svelte'
- '.github/workflows/history-microservice.fta.yml'
pull_request:
branches:
- master
paths:
- 'history-microservice/**.ts'
- 'history-microservice/**.tsx'
- 'history-microservice/**.js'
- 'history-microservice/**.cjs'
- 'history-microservice/**.json'
- 'history-microservice/**.svelte'
- '.github/workflows/history-microservice.fta.yml'
env:
PREVIOUS_NODE_VERSION: ${{ vars.PREVIOUS_NODE_VERSION || 'lts/*' }}
CURRENT_NODE_VERSION: ${{ vars.CURRENT_NODE_VERSION || 'latest' }}
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ env.CURRENT_NODE_VERSION }}
uses: actions/setup-node@v4
with:
node-version: ${{ env.CURRENT_NODE_VERSION }}
cache: 'npm'
cache-dependency-path: |
framework/package-lock.json
documentation-website/package-lock.json
history-microservice/package-lock.json
history-microservice/package-lock.json
cli/package-lock.json
package-lock.json
- run: npm ci
- run: cd history-microservice && npm ci && npm run language
- run: npm run fta -- history-microservice
name: history-microservice FTA
on:
push:
branches:
- main
paths:
- 'history-microservice/**.ts'
- 'history-microservice/**.tsx'
- 'history-microservice/**.js'
- 'history-microservice/**.cjs'
- 'history-microservice/**.json'
- 'history-microservice/**.svelte'
- '.github/workflows/history-microservice.fta.yml'
pull_request:
branches:
- master
paths:
- 'history-microservice/**.ts'
- 'history-microservice/**.tsx'
- 'history-microservice/**.js'
- 'history-microservice/**.cjs'
- 'history-microservice/**.json'
- 'history-microservice/**.svelte'
- '.github/workflows/history-microservice.fta.yml'
env:
PREVIOUS_NODE_VERSION: ${{ vars.PREVIOUS_NODE_VERSION || 'lts/*' }}
CURRENT_NODE_VERSION: ${{ vars.CURRENT_NODE_VERSION || 'latest' }}
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ env.CURRENT_NODE_VERSION }}
uses: actions/setup-node@v4
with:
node-version: ${{ env.CURRENT_NODE_VERSION }}
cache: 'npm'
cache-dependency-path: |
framework/package-lock.json
documentation-website/package-lock.json
history-microservice/package-lock.json
history-microservice/package-lock.json
cli/package-lock.json
package-lock.json
- run: npm ci
- run: cd history-microservice && npm ci && npm run language
- run: npm run fta -- history-microservice

framework/package-lock.json
documentation-website/package-lock.json
history-microservice/package-lock.json
history-microservice/package-lock.json
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove the duplicate entry for history-microservice/package-lock.json in the cache-dependency-path.

            history-microservice/package-lock.json
-           history-microservice/package-lock.json

Having duplicate entries does not provide any benefit and could potentially lead to confusion or errors in cache handling.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
history-microservice/package-lock.json

Copy link

sonarqubecloud bot commented Apr 6, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@Idrinth Idrinth merged commit f3cb03c into master Apr 6, 2024
57 checks passed
@Idrinth Idrinth deleted the issue-684-introduce-fta branch April 6, 2024 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: cli The cli tool of api-bench component: documentation-website related to the project's website, not the framework component: framework related to the project framework, not the website component: history-microservice Anything related to the database access microservice component: history-website anything related to the data history display page component: tooling Something to help make our life easier research researching a specific topic to makee decisions on it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add fta for the ci
1 participant