Allow environment variables to have a value.

Author: felixfontein

changelogs/fragments/442-extend-ansible-markup.yml

@@ -1,2 +1,3 @@
 major_changes:
   - "Extend plugin reference ``P(...)`` to allow referencing a role's entrypoint (https://github.com/ansible-community/antsibull-docs-ts/pull/442)."
+  - "Extend environment variable ``E(...)`` to allow specifying a value (https://github.com/ansible-community/antsibull-docs-ts/pull/442)."

src/dom.ts

@@ -94,6 +94,7 @@ export interface OptionValuePart extends Part {
 export interface EnvVariablePart extends Part {
   type: PartType.ENV_VARIABLE;
   name: string;
+  value: string | undefined;
 }
 
 export interface ReturnValuePart extends Part {

src/parser.spec.ts

@@ -126,10 +126,12 @@ describe('parser', (): void => {
     ]);
   });
   it('semantic markup test', (): void => {
-    expect(parse('foo E(a\\),b) P(foo.bar.baz#bam) baz V( b\\,\\na\\)\\\\m\\, ) O(foo) ')).toEqual([
+    expect(parse('foo E(a\\),b) E(foo=bar=baz) P(foo.bar.baz#bam) baz V( b\\,\\na\\)\\\\m\\, ) O(foo) ')).toEqual([
       [
         { type: PartType.TEXT, text: 'foo ', source: undefined },
-        { type: PartType.ENV_VARIABLE, name: 'a),b', source: undefined },
+        { type: PartType.ENV_VARIABLE, name: 'a),b', value: undefined, source: undefined },
+        { type: PartType.TEXT, text: ' ', source: undefined },
+        { type: PartType.ENV_VARIABLE, name: 'foo', value: 'bar=baz', source: undefined },
         { type: PartType.TEXT, text: ' ', source: undefined },
         {
           type: PartType.PLUGIN,
@@ -171,34 +173,38 @@ describe('parser', (): void => {
     ]);
   });
   it('semantic markup test (with source)', (): void => {
-    expect(parse('foo E(a\\),b) P(foo.bar.baz#bam) baz V( b\\,\\na\\)\\\\m\\, ) O(foo) ', { addSource: true })).toEqual(
-      [
-        [
-          { type: PartType.TEXT, text: 'foo ', source: 'foo ' },
-          { type: PartType.ENV_VARIABLE, name: 'a),b', source: 'E(a\\),b)' },
-          { type: PartType.TEXT, text: ' ', source: ' ' },
-          {
-            type: PartType.PLUGIN,
-            plugin: { fqcn: 'foo.bar.baz', type: 'bam' },
-            entrypoint: undefined,
-            source: 'P(foo.bar.baz#bam)',
-          },
-          { type: PartType.TEXT, text: ' baz ', source: ' baz ' },
-          { type: PartType.OPTION_VALUE, value: ' b,na)\\m, ', source: 'V( b\\,\\na\\)\\\\m\\, )' },
-          { type: PartType.TEXT, text: ' ', source: ' ' },
-          {
-            type: PartType.OPTION_NAME,
-            plugin: undefined,
-            entrypoint: undefined,
-            link: ['foo'],
-            name: 'foo',
-            value: undefined,
-            source: 'O(foo)',
-          },
-          { type: PartType.TEXT, text: ' ', source: ' ' },
-        ],
+    expect(
+      parse('foo E(a\\),b) E(foo=bar=baz) P(foo.bar.baz#bam) baz V( b\\,\\na\\)\\\\m\\, ) O(foo) ', {
+        addSource: true,
+      }),
+    ).toEqual([
+      [
+        { type: PartType.TEXT, text: 'foo ', source: 'foo ' },
+        { type: PartType.ENV_VARIABLE, name: 'a),b', value: undefined, source: 'E(a\\),b)' },
+        { type: PartType.TEXT, text: ' ', source: ' ' },
+        { type: PartType.ENV_VARIABLE, name: 'foo', value: 'bar=baz', source: 'E(foo=bar=baz)' },
+        { type: PartType.TEXT, text: ' ', source: ' ' },
+        {
+          type: PartType.PLUGIN,
+          plugin: { fqcn: 'foo.bar.baz', type: 'bam' },
+          entrypoint: undefined,
+          source: 'P(foo.bar.baz#bam)',
+        },
+        { type: PartType.TEXT, text: ' baz ', source: ' baz ' },
+        { type: PartType.OPTION_VALUE, value: ' b,na)\\m, ', source: 'V( b\\,\\na\\)\\\\m\\, )' },
+        { type: PartType.TEXT, text: ' ', source: ' ' },
+        {
+          type: PartType.OPTION_NAME,
+          plugin: undefined,
+          entrypoint: undefined,
+          link: ['foo'],
+          name: 'foo',
+          value: undefined,
+          source: 'O(foo)',
+        },
+        { type: PartType.TEXT, text: ' ', source: ' ' },
       ],
-    );
+    ]);
     expect(parse('P(foo.bar.baz#role) P(foo.bar.baz#role:entrypoint)')).toEqual([
       [
         {

src/parser.ts

@@ -290,8 +290,14 @@ const PARSER: CommandParserEx[] = [
     parameters: 1,
     escapedArguments: true,
     process: (args, _, source, whitespace) => {
-      const env = processWhitespace(args[0] as string, whitespace, true, true);
-      return <EnvVariablePart>{ type: PartType.ENV_VARIABLE, name: env, source: source };
+      let env = processWhitespace(args[0] as string, whitespace, true, true);
+      let value: string | undefined;
+      const eq = env.indexOf('=');
+      if (eq >= 0) {
+        value = env.substring(eq + 1, env.length);
+        env = env.substring(0, eq);
+      }
+      return <EnvVariablePart>{ type: PartType.ENV_VARIABLE, name: env, value: value, source: source };
     },
   },
   {