3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-21 23:46:21 +01:00

Describe only markdown in the package description and the README's tagline

This commit is contained in:
2026-10-09 12:53:49 +02:00
committed by Lillem4n
parent 310207fab5
commit c66cbc288b
4 changed files with 3 additions and 10 deletions
+1 -1
View File
@@ -15,7 +15,7 @@
keys. Build it as JSON holds it: `date.toISOString()`, `Object.fromEntries(map)`, keys. Build it as JSON holds it: `date.toISOString()`, `Object.fromEntries(map)`,
`Array.from(bytes)`, `{ ...instance }`. `Array.from(bytes)`, `{ ...instance }`.
- The README opens with what the package does and for whom, and `package.json` carries search - The README opens with what the package does and for whom, and `package.json` carries search
keywords. keywords. Both describe markdown alone until HTML lands at `0.3.0`.
- The source moves to [github.com/larvit/adf-codec](https://github.com/larvit/adf-codec), where - The source moves to [github.com/larvit/adf-codec](https://github.com/larvit/adf-codec), where
issues and pull requests go. issues and pull requests go.
- **Breaking:** directives, the inline opaque carry among them (now `!adf:carry{json="…"}`), are - **Breaking:** directives, the inline opaque carry among them (now `!adf:carry{json="…"}`), are
+1 -1
View File
@@ -3,7 +3,7 @@
[![npm](https://img.shields.io/npm/v/@larvit/adf-codec)](https://www.npmjs.com/package/@larvit/adf-codec) [![npm](https://img.shields.io/npm/v/@larvit/adf-codec)](https://www.npmjs.com/package/@larvit/adf-codec)
[![CI](https://github.com/larvit/adf-codec/actions/workflows/ci.yml/badge.svg)](https://github.com/larvit/adf-codec/actions/workflows/ci.yml) [![CI](https://github.com/larvit/adf-codec/actions/workflows/ci.yml/badge.svg)](https://github.com/larvit/adf-codec/actions/workflows/ci.yml)
Convert Atlassian Document Format (ADF) to and from markdown and HTML, with a lossless round-trip. Convert Atlassian Document Format (ADF) to and from markdown, with a lossless round-trip.
For application developers whose app shows, edits, exports or generates the rich text Atlassian For application developers whose app shows, edits, exports or generates the rich text Atlassian
products store as ADF. products store as ADF.
+1 -2
View File
@@ -1,7 +1,7 @@
{ {
"name": "@larvit/adf-codec", "name": "@larvit/adf-codec",
"version": "0.1.0", "version": "0.1.0",
"description": "Convert Atlassian Document Format (ADF) to and from markdown and HTML, with a lossless round-trip.", "description": "Convert Atlassian Document Format (ADF) to and from markdown, with a lossless round-trip.",
"keywords": [ "keywords": [
"adf", "adf",
"atlassian", "atlassian",
@@ -9,7 +9,6 @@
"commonmark", "commonmark",
"confluence", "confluence",
"converter", "converter",
"html",
"jira", "jira",
"markdown", "markdown",
"typescript" "typescript"
-6
View File
@@ -25,7 +25,6 @@
| ID | Release | Exempt | Item | R | S | A | G | Goals | Score | | ID | Release | Exempt | Item | R | S | A | G | Goals | Score |
|---|---|---|---|---|---|---|---|---|---| |---|---|---|---|---|---|---|---|---|---|
| 90 | 0.2.0 | | **Describe only the formats the release converts in `package.json`'s description and the README's tagline.** | 1 | 1 | 6 | 7 | 3 | 21.7 |
| 88 | 0.2.0 | defect | **Build a `blockTaskItem` holding only the paragraphs and extensions Atlassian's schema allows, in `portableMarkdownToAdf`.** | 4 | 4 | 6 | 7 | 4 | 16.4 | | 88 | 0.2.0 | defect | **Build a `blockTaskItem` holding only the paragraphs and extensions Atlassian's schema allows, in `portableMarkdownToAdf`.** | 4 | 4 | 6 | 7 | 4 | 16.4 |
| 49 | 0.2.0 | | **Read a list whose bullet or ordered delimiter changes as two lists, in every reader, and retire `!adf:listBreak`.** | 4 | 5 | 5 | 8 | 4, 5 | 15.5 | | 49 | 0.2.0 | | **Read a list whose bullet or ordered delimiter changes as two lists, in every reader, and retire `!adf:listBreak`.** | 4 | 5 | 5 | 8 | 4, 5 | 15.5 |
| 61 | 0.2.0 | decision | **Have the emitter ask the inline reader how a line reads back, in place of `line-escaping.ts` predicting it.** | 6 | 8 | 3 | 8 | 1 | 14.0 | | 61 | 0.2.0 | decision | **Have the emitter ask the inline reader how a line reads back, in place of `line-escaping.ts` predicting it.** | 6 | 8 | 3 | 8 | 1 | 14.0 |
@@ -69,11 +68,6 @@
## Details ## Details
### 90. Describe only the formats the release converts in `package.json`'s description and the README's tagline.
Both say "to and from markdown and HTML", and `0.2.0` ships no HTML (item 7 brings it in `0.3.0`):
`docs/decisions.md` §Docs describe the release being built.
### 88. Build a `blockTaskItem` holding only the paragraphs and extensions Atlassian's schema allows, in `portableMarkdownToAdf`. ### 88. Build a `blockTaskItem` holding only the paragraphs and extensions Atlassian's schema allows, in `portableMarkdownToAdf`.
`- [x] done\n\n ![a](u)` builds a `blockTaskItem` holding a `mediaSingle`, and `- [x] done\n\n > q` `- [x] done\n\n ![a](u)` builds a `blockTaskItem` holding a `mediaSingle`, and `- [x] done\n\n > q`