podlite 0.0.20 → 0.0.21

package/t/fixtures/02-inlines_inline_code.txt

@@ -1,78 +0,0 @@
-
-*This text will be italic*
-_This will also be italic_
-
-**This text will be bold**
-__This will also be bold__
-
-_You **can** combine them_
-
-
-
-~~~~~~~
-{
-  "type": "block",
-  "name": "pod",
-  "content": [
-    {
-      "type": "para",
-      "content": [
-        {
-          "type": "fcode",
-          "name": "I",
-          "content": [
-            "This text will be italic"
-          ]
-        },
-        "\n",
-        {
-          "type": "fcode",
-          "name": "I",
-          "content": [
-            "This will also be italic"
-          ]
-        }
-      ]
-    },
-    {
-      "type": "para",
-      "content": [
-        {
-          "type": "fcode",
-          "name": "B",
-          "content": [
-            "This text will be bold"
-          ]
-        },
-        "\n",
-        {
-          "type": "fcode",
-          "name": "B",
-          "content": [
-            "This will also be bold"
-          ]
-        }
-      ]
-    },
-    {
-      "type": "para",
-      "content": [
-        {
-          "type": "fcode",
-          "name": "I",
-          "content": [
-            "You ",
-            {
-              "type": "fcode",
-              "name": "B",
-              "content": [
-                "can"
-              ]
-            },
-            " combine them"
-          ]
-        }
-      ]
-    }
-  ]
-}

package/t/fixtures/02-inlines_thematic_break.txt

@@ -1,9 +0,0 @@
-
----
-
-~~~~~~~
-{
-  "type": "block",
-  "name": "pod",
-  "content": []
-}

package/t/fixtures/03-blockquotes_blockquote.txt

@@ -1,28 +0,0 @@
-As Kanye West said:
-
-> We're living the future so
-> the present is our past.
-~~~~~~~
-{
-  "type": "block",
-  "name": "pod",
-  "content": [
-    {
-      "type": "para",
-      "content": [
-        "As Kanye West said:"
-      ]
-    },
-    {
-      "type": "nested",
-      "content": [
-        {
-          "type": "para",
-          "content": [
-            "We're living the future so\nthe present is our past."
-          ]
-        }
-      ]
-    }
-  ]
-}

package/t/fixtures/04-tables_table.txt

@@ -1,77 +0,0 @@
-First Header | Second Header
------------- | -------------
-Content from cell 1 | Content from cell 2
-Content in the first column | Content in the second column
-~~~~~~~
-{
-  "type": "block",
-  "name": "pod",
-  "content": [
-    {
-      "name": "table",
-      "type": "block",
-      "content": [
-        {
-          "name": "table_row",
-          "type": "block",
-          "content": [
-            {
-              "name": "table_cell",
-              "type": "block",
-              "content": [
-                "First Header"
-              ]
-            },
-            {
-              "name": "table_cell",
-              "type": "block",
-              "content": [
-                "Second Header"
-              ]
-            }
-          ]
-        },
-        {
-          "name": "table_row",
-          "type": "block",
-          "content": [
-            {
-              "name": "table_cell",
-              "type": "block",
-              "content": [
-                "Content from cell 1"
-              ]
-            },
-            {
-              "name": "table_cell",
-              "type": "block",
-              "content": [
-                "Content from cell 2"
-              ]
-            }
-          ]
-        },
-        {
-          "name": "table_row",
-          "type": "block",
-          "content": [
-            {
-              "name": "table_cell",
-              "type": "block",
-              "content": [
-                "Content in the first column"
-              ]
-            },
-            {
-              "name": "table_cell",
-              "type": "block",
-              "content": [
-                "Content in the second column"
-              ]
-            }
-          ]
-        }
-      ]
-    }
-  ]
-}

package/t/fixtures/05-strikethrough_strikethrough.txt

@@ -1,12 +0,0 @@
-~~this~~
-~~~~~~~
-{
-  "type": "block",
-  "name": "pod",
-  "content": [
-    {
-      "type": "para",
-      "content": []
-    }
-  ]
-}

package/t/fixtures-md/00-main.t

@@ -1,34 +0,0 @@
-=begin code :id('links')
-
-### Table of Contents
-
--   [lint][1]
-    -   [Parameters][2]
-
-
-[1]: #lint
-
-[2]: #parameters
-=end code
-
-=begin code
-## build
-
-Generate JavaScript documentation as a list of parsed JSDoc
-comments, given a root file as a path.
-=end code
-
-=begin code :id('broken_refs')
-### Parameters
-
--   `comments` **[Array][17]<[Object][19]>** parsed comments
--   `args` **[Object][19]** Options that can customize the output
-=end code 
-
-=begin code :id('link')
-[#raku IRC channel](https://raku.org/community/irc)
-=end code
-
-=begin code :id('images')
-![foo](/url "title")
-=end code

package/t/fixtures-md/01-node-api.t

@@ -1,234 +0,0 @@
-=begin code
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
--   [lint][1]
-    -   [Parameters][2]
-    -   [Examples][3]
--   [build][4]
-    -   [Parameters][5]
-    -   [Examples][6]
--   [formats][7]
--   [formats.html][8]
-    -   [Parameters][9]
-    -   [Examples][10]
--   [formats.markdown][11]
-    -   [Parameters][12]
-    -   [Examples][13]
--   [formats.json][14]
-    -   [Parameters][15]
-    -   [Examples][16]
-
-## lint
-
-Lint files for non-standard or incorrect documentation
-information, returning a potentially-empty string
-of lint information intended for human-readable output.
-
-### SParameterssss
-
--   `indexes` **([Array][17]&lt;[string][18]> | [string][18])** files to process
--   `args` **[Object][19]** args
-    -   `args.external` **[Array][17]&lt;[string][18]>** a string regex / glob match pattern
-        that defines what external modules will be whitelisted and included in the
-        generated documentation.
-    -   `args.shallow` **[boolean][20]** whether to avoid dependency parsing
-        even in JavaScript code. (optional, default `false`)
-    -   `args.inferPrivate` **[string][18]?** a valid regular expression string
-        to infer whether a code element should be private, given its naming structure.
-        For instance, you can specify `inferPrivate: '^_'` to automatically treat
-        methods named like `_myMethod` as private.
-    -   `args.extension` **([string][18] \| [Array][17]&lt;[string][18]>)?** treat additional file extensions
-        as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
-
-### Examples
-
-```javascript
-documentation.lint('file.js').then(lintOutput => {
-  if (lintOutput) {
-    console.log(lintOutput);
-    process.exit(1);
-  } else {
-    process.exit(0);
-  }
-});
-```
-
-Returns **[Promise][21]** promise with lint results
-
-## build
-
-Generate JavaScript documentation as a list of parsed JSDoc
-comments, given a root file as a path.
-
-### Parameters
-
--   `indexes` **([Array][17]&lt;[string][18]> | [string][18])** files to process
--   `args` **[Object][19]** args
-    -   `args.external` **[Array][17]&lt;[string][18]>** a string regex / glob match pattern
-        that defines what external modules will be whitelisted and included in the
-        generated documentation.
-    -   `args.shallow` **[boolean][20]** whether to avoid dependency parsing
-        even in JavaScript code. (optional, default `false`)
-    -   `args.order` **[Array][17]&lt;([string][18] \| [Object][19])>** optional array that
-        defines sorting order of documentation (optional, default `[]`)
-    -   `args.access` **[Array][17]&lt;[string][18]>** an array of access levels
-        to output in documentation (optional, default `[]`)
-    -   `args.hljs` **[Object][19]?** hljs optional args
-        -   `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language (optional, default `false`)
-        -   `args.hljs.languages` **[Array][17]?** languages for hljs to choose from
-    -   `args.inferPrivate` **[string][18]?** a valid regular expression string
-        to infer whether a code element should be private, given its naming structure.
-        For instance, you can specify `inferPrivate: '^_'` to automatically treat
-        methods named like `_myMethod` as private.
-    -   `args.extension` **([string][18] \| [Array][17]&lt;[string][18]>)?** treat additional file extensions
-        as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
-
-### Examples
-
-```javascript
-var documentation = require('documentation');
-
-documentation.build(['index.js'], {
-  // only output comments with an explicit @public tag
-  access: ['public']
-}).then(res => {
-  // res is an array of parsed comments with inferred properties
-  // and more: everything you need to build documentation or
-  // any other kind of code data.
-});
-```
-
-Returns **[Promise][21]** results
-
-## formats
-
-Documentation's formats are modular methods that take comments
-and config as input and return Promises with results,
-like stringified JSON, markdown strings, or Vinyl objects for HTML
-output.
-
-## formats.html
-
-Formats documentation as HTML.
-
-### Parameters
-
--   `comments` **[Array][17]&lt;[Comment][22]>** parsed comments
--   `config` **[Object][19]** Options that can customize the output
-    -   `config.theme` **[string][18]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
-
-### Examples
-
-```javascript
-var documentation = require('documentation');
-var streamArray = require('stream-array');
-var vfs = require('vinyl-fs');
-
-documentation.build(['index.js'])
-  .then(documentation.formats.html)
-  .then(output => {
-    streamArray(output).pipe(vfs.dest('./output-directory'));
-  });
-```
-
-Returns **[Promise][21]&lt;[Array][17]&lt;[Object][19]>>** Promise with results
-
-## formats.markdown
-
-Formats documentation as
-[Markdown][23].
-
-### Parameters
-
--   `comments` **[Array][17]&lt;[Object][19]>** parsed comments
--   `args` **[Object][19]** Options that can customize the output
-
-### Examples
-
-```javascript
-var documentation = require('documentation');
-var fs = require('fs');
-
-documentation.build(['index.js'])
-  .then(documentation.formats.md)
-  .then(output => {
-    // output is a string of Markdown data
-    fs.writeFileSync('./output.md', output);
-  });
-```
-
-Returns **[Promise][21]&lt;[string][18]>** a promise of the eventual value
-
-## formats.json
-
-Formats documentation as a JSON string.
-
-### Parameters
-
--   `comments` **[Array][17]&lt;[Comment][22]>** parsed comments
-
-### Examples
-
-```javascript
-var documentation = require('documentation');
-var fs = require('fs');
-
-documentation.build(['index.js'])
-  .then(documentation.formats.json)
-  .then(output => {
-    // output is a string of JSON data
-    fs.writeFileSync('./output.json', output);
-  });
-```
-
-Returns **[Promise][21]&lt;[string][18]>** 
-
-[1]: #lint
-
-[2]: #parameters
-
-[3]: #examples
-
-[4]: #build
-
-[5]: #parameters-1
-
-[6]: #examples-1
-
-[7]: #formats
-
-[8]: #formatshtml
-
-[9]: #parameters-2
-
-[10]: #examples-2
-
-[11]: #formatsmarkdown
-
-[12]: #parameters-3
-
-[13]: #examples-3
-
-[14]: #formatsjson
-
-[15]: #parameters-4
-
-[16]: #examples-4
-
-[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-
-[22]: https://developer.mozilla.org/docs/Web/API/Comment/Comment
-
-[23]: https://daringfireball.net/projects/markdown/
-
-=end code

package/t/fixtures-md/02-inlines.t

@@ -1,20 +0,0 @@
-=comment thematic break
-=begin code :id('thematic_break')
-
----
-
-=end code
-
-=begin code :id('inline_code')
-
-*This text will be italic*
-_This will also be italic_
-
-**This text will be bold**
-__This will also be bold__
-
-_You **can** combine them_
-
-
-
-=end code

package/t/fixtures-md/03-blockquotes.t

@@ -1,6 +0,0 @@
-=begin code :id('blockquote')
-As Kanye West said:
-
-> We're living the future so
-> the present is our past.
-=end code

package/t/fixtures-md/04-tables.t

@@ -1,6 +0,0 @@
-=begin code :id('table')
-First Header | Second Header
------------- | -------------
-Content from cell 1 | Content from cell 2
-Content in the first column | Content in the second column
-=end code

package/t/fixtures-md/05-strikethrough.t

@@ -1,3 +0,0 @@
-=begin code :id('strikethrough')
-~~this~~
-=end code

package/t/md2ast.test.ts

@@ -1,31 +0,0 @@
-test('adds 1 + 2 to equal 3', () => {
-    expect(1+ 2).toBe(3);
-  });
-  
-// import clean_plugin from 'pod6/built/plugin-clean-location'
-// import {cleanIds} from '../src/ids'
-// import * as path from 'path'
-// import * as fs  from 'fs'
-// const glob = require('glob')
-// import { md2ast }  from '../src/'
-// const loadTests = (testsPath) => {
-//     const pathToTests = path.resolve(__dirname, testsPath)
-//     return glob.sync(pathToTests).map( f => {
-//         const testData = fs.readFileSync(f)
-//         const [ src, dst ] = `${testData}`.split('~~~~~~~\n')
-//         return { src, dst, file: f}
-//     })
-// }
-
-// const process = (src) => {
-//     return cleanIds({skipChain: 0, podMode: 1})(clean_plugin()(md2ast(src)))
-    
-// }
-
-// describe("run parser tests", () => {
-//     loadTests('fixtures/*t').map( item => {
-//         test(item.file, ()=>expect(
-//             process(item.src)).toEqual( JSON.parse(item.dst))
-//         )
-//     })
-// })