Skip to content

Commit

Permalink
Parchment delta renaming (#1)
Browse files Browse the repository at this point in the history
* Parchment delta

* Add CI

* Update README with badges
  • Loading branch information
amantoux committed Jan 14, 2024
1 parent 9cabea1 commit ab6ca5b
Show file tree
Hide file tree
Showing 9 changed files with 114 additions and 149 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/build.yml
@@ -0,0 +1,35 @@
name: build

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: subosito/flutter-action@v2
with:
flutter-version: "3.16.6"
cache: true
# Manually Update this `key`
cache-key: "202401114"
- run: dart pub global activate coverage

- name: Install dependencies
run: flutter pub get

- name: Verify formatting
run: dart format --output=none --set-exit-if-changed .

- name: Analyze project source
run: flutter analyze --fatal-infos

- name: Run tests
run: flutter test --coverage

- name: Codecov
uses: codecov/codecov-action@v3
with:
files: ./coverage/lcov.info
fail_ci_if_error: true
17 changes: 0 additions & 17 deletions .travis.yml

This file was deleted.

77 changes: 0 additions & 77 deletions CHANGELOG.md
@@ -1,77 +0,0 @@
## 3.0.0-nullsafety.2

* Added an option to cleanup semantics in `Delta.diff`. See dartdoc for more details.

## 3.0.0-nullsafety.1

* Added `Delta.diff` implementation (#24)

## 3.0.0-nullsafety.0

* Migrated to null safety.
* Fixed an issue with usage of double.infinity in DeltaIterator.
Replaced with special value of DeltaIterator.maxLength.

## 2.0.1

* Updated dependency on quiver_hashcode to main quiver package.

## 2.0.0

* **Breaking change**: changed `Operation.value` type from `dynamic` to `Object` to allow better
static analysis and prevent bugs where operation value is always assumed to be a String object.
If you get analyzer errors after this change you must add an explicit type cast on the
operation value to the desired type (String or the type of an embed).
* Added: `dataDecoder` parameter to `Delta.fromJson` and `Operation.fromJson`. Can be used to convert
raw JSON values to concrete data types. Mainly useful with embedded data. Text data should always
be `String`.
* Fixed: changed `Delta.fromJson` type of the `data` parameter to `List` so that this factory method
can actually be used with the output of `jsonDecode`.

## 1.1.3

* Reverted last change to operation value type and will publish it as a major version update
since it's breaking existing users.

## 1.1.2

* Changed operation value type from `dynamic` to `Object` to allow better static analysis.
If you get analyzer errors after this change you must add an explicit type cast on the operation
value to the desired class.

## 1.1.1

* Fix iterator for custom embed objects (#14)

## 1.1.0

* Changed insert operations to allow inserting dynamic object values. (#13)
Object values must be JSON-serializable.

## 1.0.2

* Fix attributes comparison for operations when attributes have complex values (maps, lists).

## 1.0.1

* Fixed assertion error for sequences of insert-delete-insert operations.

## 1.0.0

* Added `Delta.invert()`, `Delta.slice()` and `Delta.invertAttributes()`.

## 1.0.0-dev.4.0

* Internal clean-up replacing hardcoded strings with constants.

## 1.0.0-dev.3.0

* Updated dependency on quiver_hashcode.

## 1.0.0-dev.2.0

* Prepare for Dart 2 stable.

## 1.0.0-dev.1.0

* Initial release.
24 changes: 0 additions & 24 deletions LICENSE

This file was deleted.

6 changes: 3 additions & 3 deletions README.md
@@ -1,4 +1,4 @@
[![Build Status](https://www.travis-ci.com/pulyaevskiy/quill-delta-dart.svg?branch=master)](https://www.travis-ci.com/pulyaevskiy/quill-delta-dart) [![codecov](https://codecov.io/gh/pulyaevskiy/quill-delta-dart/branch/master/graph/badge.svg)](https://codecov.io/gh/pulyaevskiy/quill-delta-dart) [![Pub](https://img.shields.io/pub/v/quill_delta.svg)](https://pub.dev/packages/quill_delta)
[![build](https://github.com/fleather-editor/parchment-delta/actions/workflows/build.yml/badge.svg)](https://github.com/fleather-editor/parchment-delta/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/fleather-editor/parchment-delta/graph/badge.svg?token=9JDVTZL4VA)](https://codecov.io/gh/fleather-editor/parchment-delta)

Implementation of Quill editor Delta format in Dart. Refer to official
[documentation][] for more details.
Expand All @@ -8,7 +8,7 @@ Implementation of Quill editor Delta format in Dart. Refer to official
## Usage

```dart
import 'package:quill_delta/quill_delta.dart';
import 'package:parchment_delta/parchment_delta.dart';
void main() {
var doc = new Delta()..insert('Hello world', {'h': '1'});
Expand Down Expand Up @@ -41,4 +41,4 @@ void main() {

Please file feature requests and bugs at the [issue tracker][tracker].

[tracker]: https://github.com/pulyaevskiy/quill-delta-dart/issues
[tracker]: https://github.com/fleather-editor/parchment-delta/issues
2 changes: 1 addition & 1 deletion example/main.dart
@@ -1,4 +1,4 @@
import 'package:quill_delta/quill_delta.dart';
import 'package:parchment_delta/parchment_delta.dart';

void main() {
var doc = Delta()..insert('Hello world', {'h': '1'});
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions pubspec.yaml
@@ -1,7 +1,7 @@
name: quill_delta
name: parchment_delta
description: Simple and expressive format for describing rich-text content created for Quill.js editor. This package is unofficial port to Dart from JavaScript.
version: 1.0.0
homepage: https://github.com/fleather-editor/quill-delta.git
homepage: https://github.com/fleather-editor/parchment-delta.git

environment:
sdk: '>=3.2.0 <4.0.0'
Expand Down

0 comments on commit ab6ca5b

Please sign in to comment.