Implement first batch of semantic markup commands (the easy ones).

Author: felixfontein

src/parser.spec.ts

@@ -42,6 +42,46 @@ describe('parser tests', (): void => {
       ],
     ]);
   });
+  it('classic markup test II', (): void => {
+    expect(
+      parse(
+        'foo I(bar) baz C( bam ) B( ( boo ) ) U(https://example.com/?foo=bar)HORIZONTALLINE L(foo ,  https://bar.com) R( a , b )M(foo.bar.baz)HORIZONTALLINEx M(foo.bar.baz.bam)',
+        { only_classic_markup: true },
+      ),
+    ).toEqual([
+      [
+        { type: PartType.TEXT, text: 'foo ' },
+        { type: PartType.ITALIC, text: 'bar' },
+        { type: PartType.TEXT, text: ' baz ' },
+        { type: PartType.CODE, text: ' bam ' },
+        { type: PartType.TEXT, text: ' ' },
+        { type: PartType.BOLD, text: ' ( boo ' },
+        { type: PartType.TEXT, text: ' ) ' },
+        { type: PartType.URL, url: 'https://example.com/?foo=bar' },
+        { type: PartType.HORIZONTAL_LINE },
+        { type: PartType.TEXT, text: ' ' },
+        { type: PartType.LINK, text: 'foo', url: 'https://bar.com' },
+        { type: PartType.TEXT, text: ' ' },
+        { type: PartType.RST_REF, text: ' a', ref: 'b ' },
+        { type: PartType.MODULE, fqcn: 'foo.bar.baz' },
+        { type: PartType.TEXT, text: 'HORIZONTALLINEx ' },
+        { type: PartType.MODULE, fqcn: 'foo.bar.baz.bam' },
+      ],
+    ]);
+  });
+  it('semantic markup test', (): void => {
+    expect(parse('foo E(a\\),b) P(foo.bar.baz  ,  bam) baz V( b\\,\\na\\)\\\\m\\, ) ')).toEqual([
+      [
+        { type: PartType.TEXT, text: 'foo ' },
+        { type: PartType.ENV_VARIABLE, name: 'a),b' },
+        { type: PartType.TEXT, text: ' ' },
+        { type: PartType.PLUGIN, plugin: { fqcn: 'foo.bar.baz', type: 'bam' } },
+        { type: PartType.TEXT, text: ' baz ' },
+        { type: PartType.OPTION_VALUE, value: ' b,na)\\m, ' },
+        { type: PartType.TEXT, text: ' ' },
+      ],
+    ]);
+  });
   it('bad parameter parsing (no escaping, throw error)', (): void => {
     expect(async () => parse('M(', { errors: 'exception' })).rejects.toThrow(
       'While parsing M() at index 1: Cannot find closing ")" after last parameter',

src/parser.ts

@@ -5,7 +5,7 @@
 */
 
 import { ParsingOptions, PluginIdentifier } from './opts';
-import { isFQCN } from './ansible';
+import { isFQCN, isPluginType } from './ansible';
 
 export enum PartType {
   ERROR = 0,
@@ -132,6 +132,15 @@ export type AnyPart =
 
 export type Paragraph = AnyPart[];
 
+function parseOptionLike(
+  value: string,
+  opts: ParsingOptions,
+  type: PartType.OPTION_NAME | PartType.RETURN_VALUE,
+): OptionNamePart | ReturnValuePart {
+  // TODO
+  throw Error('Not yet supported');
+}
+
 interface CommandParser {
   command: string;
   parameters: number;
@@ -219,7 +228,58 @@ const PARSER: CommandParser[] = [
     },
   },
   // Semantic Ansible docs markup:
-  // TODO
+  {
+    command: 'P',
+    parameters: 2,
+    escaped_arguments: true,
+    process: (args) => {
+      const fqcn = args[0] as string;
+      if (!isFQCN(fqcn)) {
+        throw Error(`Plugin name "${fqcn}" is not a FQCN`);
+      }
+      const type = args[1] as string;
+      if (!isPluginType(type)) {
+        throw Error(`Plugin type "${type}" is not valid`);
+      }
+      return <PluginPart>{ type: PartType.PLUGIN, plugin: { fqcn: fqcn, type: type } };
+    },
+  },
+  {
+    command: 'E',
+    parameters: 1,
+    escaped_arguments: true,
+    process: (args) => {
+      const env = args[0] as string;
+      return <EnvVariablePart>{ type: PartType.ENV_VARIABLE, name: env };
+    },
+  },
+  {
+    command: 'V',
+    parameters: 1,
+    escaped_arguments: true,
+    process: (args) => {
+      const value = args[0] as string;
+      return <OptionValuePart>{ type: PartType.OPTION_VALUE, value: value };
+    },
+  },
+  {
+    command: 'O',
+    parameters: 1,
+    escaped_arguments: true,
+    process: (args, opts) => {
+      const value = args[0] as string;
+      return parseOptionLike(value, opts, PartType.OPTION_NAME);
+    },
+  },
+  {
+    command: 'RV',
+    parameters: 1,
+    escaped_arguments: true,
+    process: (args, opts) => {
+      const value = args[0] as string;
+      return parseOptionLike(value, opts, PartType.RETURN_VALUE);
+    },
+  },
 ];
 
 const PARSER_COMMANDS: Map<string, CommandParser> = (() => {