From 75137f546ff2624b687d85b3faac04e093bd5435 Mon Sep 17 00:00:00 2001 From: Amirhossein Alibakhshi Date: Wed, 9 Jul 2025 12:17:56 +0330 Subject: [PATCH 1/6] docs: add readme and update package.json metadata --- README.md | 29 +++++++++++++++++++++++++++++ package.json | 10 ++++++++-- packages/core/README.md | 4 ++-- packages/core/package.json | 8 +++++++- 4 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..23d6eda --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +
+ +# Danger + +
+ +
+ +A monorepo for the core libraries of Danger client. + +
+ +
+ +## Packages + +- [@tapsioss/danger (core)](https://github.com/Tap30/danger/blob/main/packages/core/README.md) + +## Contributing + +Read the +[contributing guide](https://github.com/Tap30/danger/blob/main/CONTRIBUTING.md) +to learn about our development process, how to propose bug fixes and +improvements, and how to build and test your changes. + +## License + +This project is licensed under the terms of the +[MIT license](https://github.com/Tap30/danger/blob/main/LICENSE). diff --git a/package.json b/package.json index 88ab315..e39fbe4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@repo/root", "version": "0.0.0", - "description": "danger client monorepo", + "description": "A monorepo for the core libraries of Danger client.", "type": "module", "packageManager": "pnpm@9.15.0", "scripts": { @@ -65,7 +65,13 @@ "output": [] } }, - "keywords": [], + "keywords": [ + "ci", + "cd", + "review-tools", + "danger-plugin", + "danger-js" + ], "license": "MIT", "devDependencies": { "@changesets/changelog-github": "^0.5.1", diff --git a/packages/core/README.md b/packages/core/README.md index 5a625fc..380c46e 100755 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -5,9 +5,9 @@ An extensible framework for integrating [Danger.js](https://danger.systems/js/) declaratively. - + -
+
## Installation diff --git a/packages/core/package.json b/packages/core/package.json index 9b0a7c5..7c6e55e 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -30,7 +30,13 @@ ] } }, - "keywords": [], + "keywords": [ + "ci", + "cd", + "review-tools", + "danger-plugin", + "danger-js" + ], "license": "MIT", "peerDependencies": { "danger": "^13.0.4" From 6815602211eab10215fcd682952cb7e76fa66dfd Mon Sep 17 00:00:00 2001 From: Amirhossein Alibakhshi Date: Wed, 9 Jul 2025 12:19:12 +0330 Subject: [PATCH 2/6] add changeset empty file --- .changeset/cool-places-dig.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/cool-places-dig.md diff --git a/.changeset/cool-places-dig.md b/.changeset/cool-places-dig.md new file mode 100644 index 0000000..f0184f3 --- /dev/null +++ b/.changeset/cool-places-dig.md @@ -0,0 +1,6 @@ +--- + +--- + + + \ No newline at end of file From ec60707e0878be20101293e8b71ea62f9144ab52 Mon Sep 17 00:00:00 2001 From: Amirhossein Alibakhshi Date: Wed, 9 Jul 2025 12:20:16 +0330 Subject: [PATCH 3/6] fix: format linter --- .github/ISSUE_TEMPLATE/bug_report.md | 40 ++++---- .github/ISSUE_TEMPLATE/feature_request.md | 23 +++-- .github/pull_request_template.md | 3 +- package.json | 2 +- packages/core/README.md | 112 +++++++++++++--------- 5 files changed, 99 insertions(+), 81 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..8457aa9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,36 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- -**Describe the bug** -A clear and concise description of what the bug is. +**Describe the bug** A clear and concise description of what the bug is. + +**To Reproduce** Steps to reproduce the behavior: -**To Reproduce** -Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +**Expected behavior** A clear and concise description of what you expected to +happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Screenshots** If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] -**Additional context** -Add any other context about the problem here. +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + +**Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..7c87193 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,19 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Is your feature request related to a problem? Please describe.** A clear and +concise description of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Describe the solution you'd like** A clear and concise description of what you +want to happen. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Describe alternatives you've considered** A clear and concise description of +any alternative solutions or features you've considered. -**Additional context** -Add any other context or screenshots about the feature request here. +**Additional context** Add any other context or screenshots about the feature +request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5c44e53..3ddb647 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,7 +11,8 @@ Choose the right checklist for the change that you're making: ## Feature -- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. +- [ ] Implements an existing feature request or RFC. Make sure the feature + request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Tests added - [ ] Documentation added diff --git a/package.json b/package.json index e39fbe4..a33a37c 100644 --- a/package.json +++ b/package.json @@ -65,7 +65,7 @@ "output": [] } }, - "keywords": [ + "keywords": [ "ci", "cd", "review-tools", diff --git a/packages/core/README.md b/packages/core/README.md index 380c46e..44e8788 100755 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -20,32 +20,34 @@ pnpm add @tapsioss/danger ## Features - **Plugin-based Architecture**: Add custom validation logic using plugins. -- **Centralized Data Store**: Share arbitrary data across plugins during a Danger run. -- **Streamlined Dangerfile Creation**: Simplify your `dangerfile.ts` with a client-based approach. +- **Centralized Data Store**: Share arbitrary data across plugins during a + Danger run. +- **Streamlined Dangerfile Creation**: Simplify your `dangerfile.ts` with a + client-based approach. ### Client Fields -| Field Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | -| `gitlab` | [`GitLabDSL`](https://www.google.com/search?q=%5Bhttps://github.com/danger/danger-js/blob/main/source/dsl/GitLabDSL.ts%5D\(https://github.com/danger/danger-js/blob/main/source/dsl/GitLabDSL.ts\)) | GitLab-specific information for the current merge request. | -| `github` | [`GitHubDSL`](https://www.google.com/search?q=%5Bhttps://github.com/danger/danger-js/blob/main/source/dsl/GitHubDSL.ts%5D\(https://github.com/danger/danger-js/blob/main/source/dsl/GitHubDSL.ts\)) | GitHub-specific information for the current pull request. | -| `git` | [`GitDSL`](https://www.google.com/search?q=%5Bhttps://github.com/danger/danger-js/blob/main/source/dsl/GitDSL.ts%5D\(https://github.com/danger/danger-js/blob/main/source/dsl/GitDSL.ts\)) | Git-related information such as modified, created, and deleted files. | -| `results` | [`DangerResults`](https://www.google.com/search?q=%5Bhttps://github.com/danger/danger-js/blob/main/source/dsl/DangerResults.ts%5D\(https://github.com/danger/danger-js/blob/main/source/dsl/DangerResults.ts\)) | The shared Danger results object used to store warnings, fails, messages, etc. | -| `data` | `Record` | Arbitrary data storage shared across plugins for this Danger run. | -| `modifiedFiles` | `string[]` | List of files that have been modified in the current merge request. | -| `createdFiles` | `string[]` | List of files that have been newly created in the current merge request. | -| `deletedFiles` | `string[]` | List of files that have been deleted in the current merge request. | +| Field Name | Type | Description | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- | +| `gitlab` | [`GitLabDSL`]() | GitLab-specific information for the current merge request. | +| `github` | [`GitHubDSL`]() | GitHub-specific information for the current pull request. | +| `git` | [`GitDSL`]() | Git-related information such as modified, created, and deleted files. | +| `results` | [`DangerResults`]() | The shared Danger results object used to store warnings, fails, messages, etc. | +| `data` | `Record` | Arbitrary data storage shared across plugins for this Danger run. | +| `modifiedFiles` | `string[]` | List of files that have been modified in the current merge request. | +| `createdFiles` | `string[]` | List of files that have been newly created in the current merge request. | +| `deletedFiles` | `string[]` | List of files that have been deleted in the current merge request. | ### Client Methods -| Method Name | Type | Description | -| :---------- | :--------------------------------------------------------------------------- | :--------------------------------------------------------- | -| `warn` | `(msg: string, file?: string, line?: number) => void` | Function to mark a warning in the Danger output. | -| `fail` | `(msg: string, file?: string, line?: number) => void` | Function to mark a failure in the Danger output. | -| `message` | `(msg: string, file?: string, line?: number) => void` | Function to add a general message to the Danger report. | -| `markdown` | `(msg: string, file?: string, line?: number) => void` | Function to add markdown output to the Danger report. | -| `use` | `