Add getSectionNumeral() function (#1659)

Co-authored-by: Guillaume Grossetie <ggrossetie@yuzutech.fr>
asciidoctor · Sep 24, 2022 · 575221c · 575221c
1 parent 99d06f7
commit 575221c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/packages/core/spec/share/asciidoctor-spec.cjs b/packages/core/spec/share/asciidoctor-spec.cjs
@@ -594,6 +594,7 @@ This is another paragraph.
         expect(firstSection.title).to.equal('First section')
         expect(firstSection.getSectionName()).to.equal('section')
         expect(firstSection.isNumbered()).to.equal(false)
+        expect(firstSection.getSectionNumeral()).to.equal('.')
         expect(firstSection.isSpecial()).to.equal(false)
         expect(firstSection.getCaption()).to.be.undefined()
         const secondSection = doc.getSections()[1]
@@ -603,6 +604,8 @@ This is another paragraph.
         expect(secondSection.title).to.equal('Second section')
         expect(secondSection.getSectionName()).to.equal('section')
         expect(secondSection.isNumbered()).to.equal(true)
+        expect(secondSection.getSectionNumeral()).to.equal('1.')
+        expect(secondSection.getSectionNumber()).to.equal('1.')
         expect(secondSection.isSpecial()).to.equal(false)
         expect(secondSection.getCaption()).to.be.undefined()
         const abstractSection = doc.getSections()[2]
@@ -612,6 +615,7 @@ This is another paragraph.
         expect(abstractSection.title).to.equal('Abstract section')
         expect(abstractSection.getSectionName()).to.equal('abstract')
         expect(abstractSection.isNumbered()).to.equal(false)
+        expect(firstSection.getSectionNumeral()).to.equal('.')
         expect(abstractSection.isSpecial()).to.equal(true)
         expect(abstractSection.getCaption()).to.be.undefined()
         const appendixSection = doc.getSections()[3]
@@ -620,6 +624,7 @@ This is another paragraph.
         expect(appendixSection.getTitle()).to.equal('Copyright and License')
         expect(appendixSection.title).to.equal('Copyright and License')
         expect(appendixSection.getSectionName()).to.equal('appendix')
+        expect(appendixSection.getSectionNumeral()).to.equal('A.')
         expect(appendixSection.isNumbered()).to.equal(true)
         expect(appendixSection.isSpecial()).to.equal(true)
         expect(appendixSection.getCaption()).to.equal('Appx A: ')

diff --git a/packages/core/src/asciidoctor-core-api.js b/packages/core/src/asciidoctor-core-api.js
@@ -744,6 +744,17 @@ Section.prototype.setSectionName = function (value) {
   this.sectname = value
 }
 
+/**
+ * Get the section numeral of this section.
+ * @returns {string}
+ * @memberof Section
+ */
+Section.prototype.getSectionNumeral = function () {
+  return this.$sectnum()
+}
+
+Section.prototype.getSectionNumber = Section.prototype.getSectionNumeral
+
 /**
  * Get the flag to indicate whether this is a special section or a child of one.
  * @returns {boolean}

diff --git a/packages/core/types/index.d.ts b/packages/core/types/index.d.ts
@@ -2247,6 +2247,14 @@ export namespace Asciidoctor {
      */
     setSectionName(value: string): void;
 
+    /**
+     * Get the section number of this section.
+     */
+    getSectionNumeral(): string;
+
+    // alias
+    getSectionNumber(): string;
+
     /**
      * Get the flag to indicate whether this is a special section or a child of one.
      */