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

Issue 1047 copy over history website #1

Merged
merged 2 commits into from
May 9, 2024

Conversation

Idrinth
Copy link
Member

@Idrinth Idrinth commented May 9, 2024

No description provided.

@Idrinth Idrinth requested a review from marikadeveloper May 9, 2024 00:33
Copy link

coderabbitai bot commented May 9, 2024

Walkthrough

CodeRabbit assimilates new configurations and enhancements across various components. This includes setup for YAML, commit linting, ESLint configurations, GitHub Actions workflows, and .gitignore rules. The collective adapts for improved operations and compliance.

Changes

Files Summary
.coderabbit.yaml, .commitlintrc.json, .dictionary.txt, .editorconfig, .eslintrc.cjs, .eslintrc.yml Configuration enhancements for YAML, commit linting, dictionary expansion, editor settings, and ESLint setups for Svelte and TypeScript.
.github/... (various workflows and templates) Numerous GitHub Actions workflows introduced for commit message linting, Docker image building, greetings, labeling, and more. Templates for funding, pull requests, and releases added.
.gitignore, .idrinth-typescript-language-from-yaml.yml Enhanced ignore rules and new settings for TypeScript language from YAML configurations.

Poem by CodeRabbit:

(\/)
(..)
c(")(")
Changes flow, the code evolves,
Across the void, the problem solves.
Merging branches, crafting tools,
In digital depths, CodeRabbit rules.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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/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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 25

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between b44f119 and d0fa838.
Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (56)
  • .coderabbit.yaml (1 hunks)
  • .commitlintrc.json (1 hunks)
  • .dictionary.txt (1 hunks)
  • .editorconfig (1 hunks)
  • .eslintrc.cjs (1 hunks)
  • .eslintrc.yml (1 hunks)
  • .github/FUNDING.yml (1 hunks)
  • .github/dependabot.yml (1 hunks)
  • .github/prace.yml (1 hunks)
  • .github/pull_request_template.md (1 hunks)
  • .github/release.yml (1 hunks)
  • .github/workflows/global.commit-message.yml (1 hunks)
  • .github/workflows/global.conflibot.yml (1 hunks)
  • .github/workflows/global.docker.yml (1 hunks)
  • .github/workflows/global.editorconfiglint.yml (1 hunks)
  • .github/workflows/global.greetings.yml (1 hunks)
  • .github/workflows/global.label.yml (1 hunks)
  • .github/workflows/global.milestone.yml (1 hunks)
  • .github/workflows/global.prace.yml (1 hunks)
  • .github/workflows/global.pull-request-size.yml (1 hunks)
  • .github/workflows/global.release.yml (1 hunks)
  • .github/workflows/global.spellcheck.yml (1 hunks)
  • .github/workflows/global.test.yml (1 hunks)
  • .github/workflows/history-website.codeql.yml (1 hunks)
  • .github/workflows/history-website.eslint.yml (1 hunks)
  • .github/workflows/history-website.fta.yml (1 hunks)
  • .github/workflows/history-website.knip.yml (1 hunks)
  • .github/workflows/history-website.language-lint.yml (1 hunks)
  • .github/workflows/history-website.license-check.yml (1 hunks)
  • .github/workflows/history-website.mdlint.yml (1 hunks)
  • .github/workflows/history-website.spellcheck.yml (1 hunks)
  • .gitignore (1 hunks)
  • .idrinth-typescript-language-from-yaml.yml (1 hunks)
  • .knip.json (1 hunks)
  • .markdownlint.yaml (1 hunks)
  • .npmrc (1 hunks)
  • .spellcheckerrc.yml (1 hunks)
  • .stylelintrc.json (1 hunks)
  • CODE_OF_CONDUCT.md (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • LICENSE (1 hunks)
  • README.md (1 hunks)
  • SECURITY.md (1 hunks)
  • cypress.config.ts (1 hunks)
  • gitCommitDev.sh (1 hunks)
  • index.html (1 hunks)
  • language/de.yml (1 hunks)
  • language/en.yml (1 hunks)
  • language/it.yml (1 hunks)
  • package.json (1 hunks)
  • renovate.json (1 hunks)
  • src/App.svelte (1 hunks)
  • src/app.css (1 hunks)
  • src/lib/constants.ts (1 hunks)
  • src/lib/t.ts (1 hunks)
  • src/locales/de-overview.ts (1 hunks)
Files not processed due to max files limit (14)
  • src/locales/de.ts
  • src/locales/en-overview.ts
  • src/locales/en.ts
  • src/locales/files.ts
  • src/locales/language-key.ts
  • src/locales/languages.ts
  • src/locales/translations.ts
  • src/main.ts
  • src/vite-env.d.ts
  • svelte.config.js
  • tea.yaml
  • tsconfig.json
  • tsconfig.node.json
  • vite.config.ts
Files not reviewed due to errors (2)
  • .github/workflows/global.docker.yml (no review received)
  • .github/workflows/history-website.codeql.yml (no review received)
Files skipped from review due to trivial changes (36)
  • .coderabbit.yaml
  • .commitlintrc.json
  • .editorconfig
  • .github/FUNDING.yml
  • .github/dependabot.yml
  • .github/release.yml
  • .github/workflows/global.conflibot.yml
  • .github/workflows/global.greetings.yml
  • .github/workflows/global.label.yml
  • .github/workflows/global.prace.yml
  • .github/workflows/global.pull-request-size.yml
  • .github/workflows/global.spellcheck.yml
  • .github/workflows/history-website.fta.yml
  • .github/workflows/history-website.language-lint.yml
  • .github/workflows/history-website.license-check.yml
  • .github/workflows/history-website.spellcheck.yml
  • .gitignore
  • .idrinth-typescript-language-from-yaml.yml
  • .knip.json
  • .markdownlint.yaml
  • .npmrc
  • .spellcheckerrc.yml
  • .stylelintrc.json
  • LICENSE
  • README.md
  • SECURITY.md
  • gitCommitDev.sh
  • index.html
  • language/de.yml
  • language/en.yml
  • language/it.yml
  • renovate.json
  • src/App.svelte
  • src/app.css
  • src/lib/constants.ts
  • src/locales/de-overview.ts
Additional Context Used
Path-based Instructions (2)
cypress.config.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/lib/t.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

Additional comments not posted (13)
.github/prace.yml (2)

1-5: The configuration for PR body to include an issue reference is appropriate and enhances traceability.


6-9: The branch naming convention enforced here is clear and will aid in maintaining an organised branch history.

.github/workflows/global.milestone.yml (1)

1-15: This workflow efficiently handles milestone updates on merged pull requests, ensuring project tracking is up-to-date.

cypress.config.ts (1)

1-15: The Cypress configuration is correctly set up for end-to-end testing with appropriate hooks and base URL for local testing environments.

.github/workflows/global.editorconfiglint.yml (1)

1-18: The workflow for linting editor configurations is well-structured, ensuring adherence to coding standards on the specified branch.

.eslintrc.cjs (1)

1-29: The ESLint configuration is comprehensive and well-suited for a Svelte project using TypeScript, with appropriate environment settings and overrides for specific file types.

.github/workflows/global.commit-message.yml (1)

1-29: The workflow for linting commit messages is robust, ensuring that all commit messages adhere to the project's defined standards.

.github/workflows/global.release.yml (1)

1-27: The release workflow is well-configured to handle the publishing process dynamically based on closed milestones, ensuring a streamlined release cycle.

src/lib/t.ts (3)

7-7: Validate the regular expression used for matching.

Verification successful

The regular expression has been assimilated and tested. It functions as expected, correctly identifying target properties while excluding valid property names. @coderabbitai confirms the verification is successful.

  • toString, valueOf, and __proto__ are correctly matched.
  • valid.property is correctly not matched.
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Ensure the regular expression correctly identifies unwanted properties.

# Test: Check the regular expression against known bad and good inputs.
echo -e "toString\nvalueOf\n__proto__\nvalid.property" | grep -P '(^|\.)((__proto__|valueOf|toString)(\.|$))'

Length of output: 138


15-15: Check for potential null pointer exceptions when accessing properties.


29-29: Ensure the return value is always a string as expected.

.eslintrc.yml (1)

1-174: The ESLint configuration appears comprehensive and well-structured, covering a wide range of JavaScript and TypeScript best practices. Ensure that the rules defined align with the project's coding standards and that all team members are aware of these rules to maintain code quality.

.github/workflows/global.test.yml (1)

1-471: The GitHub Actions workflow for testing is well-structured and covers a comprehensive range of tests across different components and Node.js versions. Ensure that all paths and dependencies specified are correct and that the workflow meets the project's requirements for CI/CD processes.

Comment on lines +1 to +29
# The Pull Request is ready

- [ ] fixes #<!-- YOUR ISSUE ID HERE -->
- [ ] all actions are passing
- [ ] only fixes a single issue

## Overview

<!-- Provide a brief description of the changes introduced by this
Pull Request. -->

## Review points

<!-- List the points to be reviewed in detail
and the points you are not confident about. -->
<!-- Delete this section if not needed -->

## History-Website

- [ ] mobile view is usable
- [ ] desktop view is usable
- [ ] all new texts are added to the translation files (at least the english one)
- [ ] tests have been added (if required)
- [ ] shared code has been extracted in a different file

## Notes

<!-- Write any note or comment. You can share your thoughts or ideas. -->
<!-- Delete this section if not needed -->
Copy link

Choose a reason for hiding this comment

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

The pull request template is well-structured, promoting thorough checks and standardisation in PR submissions. Consider changing "all actions are passing" to "all actions have passed" for more formal wording.

- [ ] all actions are passing
+ [ ] all actions have passed

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
# The Pull Request is ready
- [ ] fixes #<!-- YOUR ISSUE ID HERE -->
- [ ] all actions are passing
- [ ] only fixes a single issue
## Overview
<!-- Provide a brief description of the changes introduced by this
Pull Request. -->
## Review points
<!-- List the points to be reviewed in detail
and the points you are not confident about. -->
<!-- Delete this section if not needed -->
## History-Website
- [ ] mobile view is usable
- [ ] desktop view is usable
- [ ] all new texts are added to the translation files (at least the english one)
- [ ] tests have been added (if required)
- [ ] shared code has been extracted in a different file
## Notes
<!-- Write any note or comment. You can share your thoughts or ideas. -->
<!-- Delete this section if not needed -->
# The Pull Request is ready
- [ ] fixes #<!-- YOUR ISSUE ID HERE -->
- [ ] all actions have passed
- [ ] only fixes a single issue
## Overview
<!-- Provide a brief description of the changes introduced by this
Pull Request. -->
## Review points
<!-- List the points to be reviewed in detail
and the points you are not confident about. -->
<!-- Delete this section if not needed -->
## History-Website
- [ ] mobile view is usable
- [ ] desktop view is usable
- [ ] all new texts are added to the translation files (at least the english one)
- [ ] tests have been added (if required)
- [ ] shared code has been extracted in a different file
## Notes
<!-- Write any note or comment. You can share your thoughts or ideas. -->
<!-- Delete this section if not needed -->

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
Copy link

Choose a reason for hiding this comment

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

Consider using the Oxford spelling "apologizing" to maintain consistency with international English standards, although the current spelling "apologising" is also correct.

- apologising
+ apologizing

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
* Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience


Examples of unacceptable behaviour include:

* The use of sexualised language or imagery, and sexual attention or advances of any kind
Copy link

Choose a reason for hiding this comment

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

Consider using the Oxford spelling "sexualized" to maintain consistency with international English standards, although the current spelling "sexualised" is also correct.

- sexualised
+ sexualized

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
* The use of sexualised language or imagery, and sexual attention or advances of any kind
* The use of sexualized language or imagery, and sexual attention or advances of any kind

Examples of unacceptable behaviour include:

* The use of sexualised language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
Copy link

Choose a reason for hiding this comment

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

Consider using a stronger term than "insulting" to emphasize the severity of the behavior. Perhaps "demeaning" or "disparaging" could be used.

- insulting
+ demeaning

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
* Trolling, insulting or derogatory comments, and personal or political attacks
* Trolling, demeaning or derogatory comments, and personal or political attacks

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [Contributor Covenant Version 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

Copy link

Choose a reason for hiding this comment

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

Include the definite article "the" before "Mozilla's code of conduct enforcement ladder" for grammatical correctness.

- inspired by [Mozilla's code of conduct enforcement ladder]
+ inspired by the [Mozilla's code of conduct enforcement ladder]

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

Comment on lines +37 to +43
cache-dependency-path: |
framework/package-lock.json
documentation-website/package-lock.json
history-microservice/package-lock.json
history-website/package-lock.json
cli/package-lock.json
package-lock.json
Copy link

Choose a reason for hiding this comment

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

Ensure cache paths are relevant and correct.

-            framework/package-lock.json
-            documentation-website/package-lock.json
-            history-microservice/package-lock.json
-            history-website/package-lock.json
-            cli/package-lock.json
-            package-lock.json
+            history-website/package-lock.json

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
cache-dependency-path: |
framework/package-lock.json
documentation-website/package-lock.json
history-microservice/package-lock.json
history-website/package-lock.json
cli/package-lock.json
package-lock.json
cache-dependency-path: |
history-website/package-lock.json

pre
programmatically
readme
rest-APIs
Copy link

Choose a reason for hiding this comment

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

Consider using the Oxford spelling "sexualized" for consistency with international English standards.

- sexualised
+ sexualized

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
rest-APIs
rest-APIs

subprojects
tracking.bjoern-buettner.me
ui
UI
Copy link

Choose a reason for hiding this comment

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

Avoid duplicate entries to maintain a clean and efficient dictionary.

- UI

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
UI

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

Choose a reason for hiding this comment

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

Ensure the cache path is relevant and correct.

-            history-website/package-lock.json
+            history-website/package-lock.json

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-website/package-lock.json
history-website/package-lock.json

"@idrinth/typescript-language-from-yaml": "^1.3.0",
"spellchecker-cli": "^6.2.0",
"knip": "^5.12.2",
"@idrinth-api-bench/assets": "https://github.com/idrinth-api-bench/assets"
Copy link

Choose a reason for hiding this comment

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

Ensure the repository URL is correct.

- "@idrinth-api-bench/assets": "https://github.com/idrinth-api-bench/assets"
+ "@idrinth-api-bench/assets": "git+https://github.com/idrinth-api-bench/assets.git"

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
"@idrinth-api-bench/assets": "https://github.com/idrinth-api-bench/assets"
"@idrinth-api-bench/assets": "git+https://github.com/idrinth-api-bench/assets.git"

@Idrinth Idrinth merged commit 32740da into the-one May 9, 2024
2 of 28 checks passed
@Idrinth Idrinth deleted the issue-1047-copy-over-history-website branch May 9, 2024 10:37
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.

2 participants