jupyter-book · agoose77 · Oct 21, 2024 · Oct 21, 2024 · Oct 21, 2024 · Oct 21, 2024
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -9,7 +9,6 @@
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:jest/recommended",
     "plugin:prettier/recommended"
   ],
   "globals": {
@@ -20,7 +19,7 @@
   "parserOptions": {
     "ecmaVersion": 2018,
     "sourceType": "module",
-    "project": ["./tsconfig.json"]
+    "project": ["./src/tsconfig.json", "./test/tsconfig.json", "./scripts/tsconfig.json"]
   },
   "plugins": ["@typescript-eslint", "no-skip-tests", "no-only-tests"],
   "rules": {
@@ -41,7 +40,7 @@
   "settings": {
     "import/resolver": {
       "node": {
-        "extensions": [".js", ".ts", ".spec.ts"]
+        "extensions": [".js", ".ts"]
       }
     }
   }

diff --git a/.github/workflows/lint_and_unittests.yml b/.github/workflows/lint_and_unittests.yml
@@ -10,38 +10,37 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
-      - name: Use Node.js 12.x
-        uses: actions/setup-node@v1
+      - name: Use Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 12.x
+          node-version: 20.x
       - run: npm install
       - run: npm run lint
 
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x]
+        node-version: [20.x]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
-      - name: Run the tests and generate coverage reportst
+      - name: Run the tests
         run: npm run test
-      - run: npm run build
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,8 @@ index.js
 docs/_build
 docs/examples/*.md
 docs/nodes
-docs/myst.schema.md
+docs/myst.schema.md
+*.tsbuildinfo
+
+build
+/test/compiled.ts 
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_toc.yml b/docs/_toc.yml
diff --git a/docs/commonmark.md b/docs/commonmark.md
@@ -4,5 +4,4 @@ A basic Markdown Abstract Syntax Tree, mdast, is defined at [](https://github.co
 
 ## Deviations commonmark mdast
 
-- According to the mdast spec [list items](https://github.com/syntax-tree/mdast#listitem) may only have [flow content](https://github.com/syntax-tree/mdast#flowcontent) children. However, according to the commonmark spec, list items may also be flow or phrasing content, such as [text](https://spec.commonmark.org/0.30/#example-255). This depends on spacing between the list items in the original document. In myst-spec, we choose to follow the commonmark spec and allow `ListItem` children to be `FlowContent` or `PhrasingContent`.
 - The commonmark spec presents `+++` as an invalid thematic break in [example 44](https://spec.commonmark.org/0.30/#example-44). However, in Myst `+++` is a block break, a non-commonmark feature. Therefore we simply removed example 44 in our test cases.
diff --git a/docs/examples/blocks.yml b/docs/examples/blocks.yml
@@ -4,26 +4,23 @@ cases:
       type: root
       children:
         - type: blockBreak
-    myst: |-
-      +++
+    myst: +++
   - title: block break node - with metadata
     mdast:
       type: root
       children:
         - type: blockBreak
           meta: '{"meta": "data"}'
-    myst: |-
-      +++ {"meta": "data"}
+    myst: '+++ {"meta": "data"}'
   - title: block break node - with broken metadata
     mdast:
       type: root
       children:
         - type: blockBreak
           meta: '{"meta: data}'
-    myst: |-
-      +++ {"meta: data}
+    myst: '+++ {"meta: data}'
   - title: block break nodes - dividing flow content
-    id: blockbreak
+    id: blockBreak
     mdast:
       type: root
       children:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,5 +4,4 @@ A basic Markdown Abstract Syntax Tree, mdast, is defined at [](https://github.co

		## Deviations commonmark mdast

		- According to the mdast spec [list items](https://github.com/syntax-tree/mdast#listitem) may only have [flow content](https://github.com/syntax-tree/mdast#flowcontent) children. However, according to the commonmark spec, list items may also be flow or phrasing content, such as [text](https://spec.commonmark.org/0.30/#example-255). This depends on spacing between the list items in the original document. In myst-spec, we choose to follow the commonmark spec and allow `ListItem` children to be `FlowContent` or `PhrasingContent`.
Copy link Author agoose77 Oct 21, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. I don't think this is correct w.r.t the CommonMark spec: - one two produces this CommonMark AST: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE document SYSTEM "CommonMark.dtd"> <document xmlns="http://commonmark.org/xml/1.0"> <list type="bullet" tight="true"> <item> <paragraph> <text>one</text> </paragraph> </item> </list> <paragraph> <text>two</text> </paragraph> </document> Copy link Member rowanc1 Oct 21, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Isn't this saying that we default to having a paragraph instead of text directly in the list item? Which is what is created? Copy link Author agoose77 Oct 22, 2024 • edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Our documentation states that `<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE document SYSTEM "CommonMark.dtd"> <document xmlns="http://commonmark.org/xml/1.0"> <list type="bullet" tight="true"> <item> <text>one</text> </item> </list> </document>` is permitted by the CommonMark spec. I don't see any evidence that that is the case. What I did notice is that the HTML renderer doesn't show the `<p>`, but I think that might be a rendering difference rather than a spec difference. ~~I noticed this because whilst the spec page shows `<li>TEXT</li>` in the inline example, the actual examples file does not~~. EDIT: oops, off-by-one error :P Copy link Author agoose77 Oct 22, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. To add -- if my conclusion here is incorrect, then typing this proves quite hard because it is not easy/possible to extend an existing type and change the type of children in that manner. Copy link Contributor fwkoch Nov 19, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Wow... yeah, wild that the html doesn't show the `<p>` despite it being in the AST! Oof, good catch.
		- The commonmark spec presents `+++` as an invalid thematic break in [example 44](https://spec.commonmark.org/0.30/#example-44). However, in Myst `+++` is a block break, a non-commonmark feature. Therefore we simply removed example 44 in our test cases.