From 4f5cc4028fdafe7d9fc8d36241e7cb98d4a223da Mon Sep 17 00:00:00 2001 From: Richard Russell <2265225+rars@users.noreply.github.com> Date: Thu, 18 Jan 2024 11:30:56 +0000 Subject: [PATCH 1/2] docs: symlink readme and license into npm package dist --- package.json | 2 +- projects/ngx-diff/LICENSE | 1 + projects/ngx-diff/README.md | 117 +-------------------------------- projects/ngx-diff/package.json | 5 +- 4 files changed, 5 insertions(+), 120 deletions(-) create mode 120000 projects/ngx-diff/LICENSE mode change 100644 => 120000 projects/ngx-diff/README.md diff --git a/package.json b/package.json index 3680098..67ad278 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ngx-diff", - "version": "6.0.0", + "version": "6.0.1", "scripts": { "ng": "ng", "start": "ng serve", diff --git a/projects/ngx-diff/LICENSE b/projects/ngx-diff/LICENSE new file mode 120000 index 0000000..30cff74 --- /dev/null +++ b/projects/ngx-diff/LICENSE @@ -0,0 +1 @@ +../../LICENSE \ No newline at end of file diff --git a/projects/ngx-diff/README.md b/projects/ngx-diff/README.md deleted file mode 100644 index 0c386e3..0000000 --- a/projects/ngx-diff/README.md +++ /dev/null @@ -1,116 +0,0 @@ -# ngx-diff - -[![Node.js CI](https://github.com/rars/ngx-diff/actions/workflows/node.js.yml/badge.svg)](https://github.com/rars/ngx-diff/actions/workflows/node.js.yml) - -Angular component library for displaying diffs of text. [Demo](https://rars.github.io/ngx-diff/). - -## Quickstart - -1. Install `ngx-diff` modules from npm: - ``` - npm install ngx-diff diff-match-patch-ts --save - ``` -2. Either: - - 2.1. If you are using this component in an NgModule-based setting, add `InlineDiffComponent` to your module's `imports`: - - ```typescript - import { InlineDiffComponent } from 'ngx-diff'; - - import { NgModule } from '@angular/core'; - import { BrowserModule } from '@angular/platform-browser'; - - import { AppComponent } from './app.component'; - - @NgModule({ - declarations: [AppComponent], - imports: [BrowserModule, InlineDiffComponent], - providers: [], - bootstrap: [AppComponent], - }) - export class AppModule {} - ``` - - 2.2. Or if you are using this component in a standalone component setting, add `InlineDiffComponent` to your component's `imports`: - - ```typescript - import { InlineDiffComponent } from 'ngx-diff'; - - import { Component } from '@angular/core'; - - @Component({ - selector: 'app-root', - templateUrl: './app.component.html', - styleUrls: ['./app.component.scss'], - standalone: true, - imports: [InlineDiffComponent], - }) - export class AppComponent { - // ... - } - ``` - -3. Use the `inline-diff` component by setting the `oldText` and `newText` attributes: - ```HTML - - ``` - -## Theming - -For version 3+, you can customise the appearance of the diff through various CSS variable settings. For example, in your `styles.scss` file, define: - -```SCSS -:root .my-custom-ngx-diff-theme { - --ngx-diff-border-color: #888888; - --ngx-diff-font-size: 1rem; - --ngx-diff-font-family: Consolas, Courier, monospace; - --ngx-diff-font-color: #000000; - --ngx-diff-line-number-font-color: #484848; - --ngx-diff-line-number-hover-font-color: #ffffff; - --ngx-diff-selected-border-color: #ff8000; - --ngx-diff-inserted-background-color: #9dff97; - --ngx-diff-deleted-background-color: #ff8c8c; - --ngx-diff-equal-background-color: #ffffff; - --ngx-diff-margin-background-color: #dedede; - --ngx-diff-line-number-width: 2rem; - --ngx-diff-border-width: 1px; - --ngx-diff-line-left-padding: 1rem; - --ngx-diff-bottom-spacer-height: 1rem; -} -``` - -Then use this class in your desired component in your HTML template: - -```HTML - -``` - -It is recommended to use these settings rather than attempt to override styles based upon DOM structure or class names that are internal details that may change. - -## Version history - -| Angular Version | ngx-diff Version | -| --------------- | ---------------- | -| 9 | 0.2.0 | -| 10 | 0.3.0 | -| 11 | 0.4.0 | -| 13 | 1.0.0 | -| 14 | 2.0.0 | -| 14 | 3.0.0 | -| 15 | 4.0.0 | -| 16 | 5.0.0 | -| 17 | 6.0.0 | - -## Contributions welcome! - -If you have a feature or improvement you would like to see included, please raise an issue or a PR and I will review. - -## License - -See the [LICENSE](LICENSE) file for license rights and limitations (MIT). diff --git a/projects/ngx-diff/README.md b/projects/ngx-diff/README.md new file mode 120000 index 0000000..fe84005 --- /dev/null +++ b/projects/ngx-diff/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/projects/ngx-diff/package.json b/projects/ngx-diff/package.json index 58d6613..da434e5 100644 --- a/projects/ngx-diff/package.json +++ b/projects/ngx-diff/package.json @@ -1,6 +1,6 @@ { "name": "ngx-diff", - "version": "6.0.0", + "version": "6.0.1", "peerDependencies": { "@angular/common": ">=17.0.0", "@angular/core": ">=17.0.0", @@ -14,9 +14,8 @@ "url": "https://github.com/rars/ngx-diff" }, "keywords": [ - "Angular2", "Angular", - "ng2", + "ng", "diff" ], "author": "Richard Russell", From 274d13b7455329acf98151288bf1f543ffeb7b40 Mon Sep 17 00:00:00 2001 From: Richard Russell <2265225+rars@users.noreply.github.com> Date: Thu, 18 Jan 2024 11:32:21 +0000 Subject: [PATCH 2/2] docs: update changelog --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a25568b..0d31e7e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [6.0.1](https://github.com/rars/ngx-diff/compare/v6.0.0...v6.0.1) (2024-01-18) + +### Bug Fixes + +- **ngx-diff:** include README.md and LICENSE in npm dist + ## [6.0.0](https://github.com/rars/ngx-diff/compare/v5.0.0...v6.0.0) (2023-11-08) ### Features