Merge pull request #1628 from progfay/jsr-docs

add documents for JSR

Author: progfay

README.md

@@ -14,6 +14,8 @@ parse Scrapbox notation to JavaScript Object
 $ npm i @progfay/scrapbox-parser
 ```
 
+Also, you can install `@progfay/scrapbox-parser` via [JSR](https://jsr.io/@progfay/scrapbox-parser).
+
 ## Usage
 
 ```js

src/block/CodeBlock.ts

@@ -5,6 +5,9 @@ export interface CodeBlockPack {
   rows: Row[];
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67df | code block} type
+ */
 export interface CodeBlock {
   indent: number;
   type: "codeBlock";

src/block/Line.ts

@@ -8,6 +8,9 @@ export interface LinePack {
   rows: [Row];
 }
 
+/**
+ * Scrapbox line type
+ */
 export interface Line {
   indent: number;
   type: "line";

src/block/Row.ts

@@ -1,3 +1,6 @@
+/**
+ * Scrapbox row type
+ */
 export interface Row {
   indent: number;
   text: string;

src/block/Table.ts

@@ -8,6 +8,9 @@ export interface TablePack {
   rows: Row[];
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58795996651ee5000012d4c7 | table} type
+ */
 export interface Table {
   indent: number;
   type: "table";

src/block/Title.ts

@@ -5,6 +5,9 @@ export interface TitlePack {
   rows: [Row];
 }
 
+/**
+ * Scrapbox title type
+ */
 export interface Title {
   type: "title";
   text: string;

src/block/index.ts

@@ -9,6 +9,9 @@ import type { CodeBlock } from "./CodeBlock";
 import type { Table } from "./Table";
 import type { Line } from "./Line";
 
+/**
+ * Scrapbox block type
+ */
 export type Block = Title | CodeBlock | Table | Line;
 
 export const convertToBlock = (pack: Pack): Block => {

src/block/node/DecorationNode.ts

@@ -43,6 +43,9 @@ type AsteriskDecorationChar =
   | "*-9"
   | "*-10";
 
+/**
+ * character type of decoration
+ */
 export type Decoration = Exclude<DecorationChar, "*"> | AsteriskDecorationChar;
 
 const createDecorationNode: NodeCreator<DecorationNode | PlainNode> = (

src/block/node/type.ts

@@ -4,73 +4,112 @@ interface BaseNode {
   raw: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67d8 | quote node} type
+ */
 export interface QuoteNode extends BaseNode {
   type: "quote";
   nodes: Node[];
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help-jp/Helpfeel%E8%A8%98%E6%B3%95 | Helpfeel node} type
+ */
 export interface HelpfeelNode extends BaseNode {
   type: "helpfeel";
   text: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help-jp/%E3%81%9D%E3%81%AE%E4%BB%96%E3%81%AE%E6%9B%B8%E3%81%8D%E6%96%B9#5cfa1ea397c291000095c81e | strong image node} type
+ */
 export interface StrongImageNode extends BaseNode {
   type: "strongImage";
   src: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Icon#5ec273358ee92a000078cafe | strong icon node} type
+ */
 export interface StrongIconNode extends BaseNode {
   type: "strongIcon";
   pathType: "root" | "relative";
   path: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67cb | strong node} type
+ */
 export interface StrongNode extends BaseNode {
   type: "strong";
   nodes: Node[];
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#5e7c7a17651ee50000d77b2e | formula node} type
+ */
 export interface FormulaNode extends BaseNode {
   type: "formula";
   formula: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67cc | decoration node} type
+ */
 export interface DecorationNode extends BaseNode {
   type: "decoration";
   rawDecos: string;
   decos: Decoration[];
   nodes: Node[];
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67db | code node} type
+ */
 export interface CodeNode extends BaseNode {
   type: "code";
   text: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Code_notation#587d557d651ee50000dc693d | command line node} type
+ */
 export interface CommandLineNode extends BaseNode {
   type: "commandLine";
   symbol: string;
   text: string;
 }
 
+/**
+ * Scrapbox blank node type
+ */
 export interface BlankNode extends BaseNode {
   type: "blank";
   text: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67b8 | image node} type
+ */
 export interface ImageNode extends BaseNode {
   type: "image";
   src: string;
   link: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Link | link node} type
+ */
 export interface LinkNode extends BaseNode {
   type: "link";
   pathType: "absolute" | "root" | "relative";
   href: string;
   content: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help-jp/Location%E8%A8%98%E6%B3%95 | Google Map node} type
+ */
 export interface GoogleMapNode extends BaseNode {
   type: "googleMap";
   latitude: number;
@@ -80,29 +119,44 @@ export interface GoogleMapNode extends BaseNode {
   url: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67c7 | icon node} type
+ */
 export interface IconNode extends BaseNode {
   type: "icon";
   pathType: "root" | "relative";
   path: string;
 }
 
+/**
+ * Scrapbox {@link https://scrapbox.io/help/Syntax#58348ae2651ee500008d67d5 | hash tag node} type
+ */
 export interface HashTagNode extends BaseNode {
   type: "hashTag";
   href: string;
 }
 
+/**
+ * Scrapbox number list node type
+ */
 export interface NumberListNode extends BaseNode {
   type: "numberList";
   rawNumber: string;
   number: number;
   nodes: Node[];
 }
 
+/**
+ * Scrapbox plain node type
+ */
 export interface PlainNode extends BaseNode {
   type: "plain";
   text: string;
 }
 
+/**
+ * Scrapbox node type
+ */
 export type Node =
   | QuoteNode
   | HelpfeelNode

src/parse.ts

@@ -4,18 +4,38 @@ import { packRows } from "./block/Pack";
 
 import type { Block } from "./block";
 
+/**
+ * parser option type
+ */
 export interface ParserOption {
+  /**
+   * is Scrapbox notation text including title
+   */
   hasTitle?: boolean;
 }
 
+/**
+ * Scrapbox page type
+ */
 export type Page = Block[];
 
+/**
+ * parse Scrapbox notation text into JavaScript Object
+ * @param input raw Scrapbox notation text
+ * @param opts parser options
+ * @returns syntax tree of parsed input
+ */
 export const parse = (input: string, opts?: ParserOption): Page => {
   const rows = parseToRows(input);
   const packs = packRows(rows, { hasTitle: opts?.hasTitle ?? true });
   return packs.map(convertToBlock);
 };
 
+/**
+ * get title of Scrapbox page
+ * @param input raw Scrapbox notation text
+ * @returns title of input Scrapbox page
+ */
 export const getTitle = (input: string): string => {
   const match = /^\s*\S.*$/m.exec(input);
   return match?.[0]?.trim() ?? "Untitled";