fix: jsdocDescriptionWithDot with germany words

issue: #76

src/descriptionFormatter.ts

@@ -149,7 +149,7 @@ function formatDescription(
  paragraph = capitalizer(paragraph);
  if (options.jsdocDescriptionWithDot)
  paragraph = paragraph.replace(
- /(\w)$/g,
+ /([\wäöüÄÖÜß])$/g,
  "$1.",
  ); // Insert dot if needed
 

src/parser.ts

@@ -302,13 +302,10 @@ function convertCommentDescToDescTag(parsed: commentParser.Comment): void {
  let description = parsed.description || "";
  parsed.description = "";
 
- parsed.tags = parsed.tags.filter((t) => {
- if (t.tag.toLowerCase() === DESCRIPTION) {
- // get description from source as some words may be parsed as the type
- // or name
- const desc = t.source.replace(/^@\w+/, "").trim();
- if (desc) {
- description += "\n\n" + desc;
+ parsed.tags = parsed.tags.filter(({ description: _description, tag }) => {
+ if (tag.toLowerCase() === DESCRIPTION) {
+ if (_description.trim()) {
+ description += "\n\n" + _description;
  }
  return false;
  } else {

tests/__snapshots__/paragraph.test.js.snap

@@ -11,6 +11,19 @@ exports[`\`#\` in text 1`] = `
 "
 `;
 
+exports[`Germany description with dot 1`] = `
+"/**
+ * Wir brauchen hier eine effizientere Lösung. Die generierten Dateien sind zu groß.
+ *
+ * Wir brauchen hier eine effizientere Lösung. Die generierten Dateien sind zu 3434.
+ *
+ * Wir brauchen hier eine effizientere Lösung. Die generierten Dateien sind zu groß.
+ *
+ * @param a Ssss.
+ */
+"
+`;
+
 exports[`code in description 1`] = `
 "/**
  * \`Touchable\`: Taps done right.
@@ -392,7 +405,7 @@ exports[`numbers and code in description 3`] = `
  * Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
  * tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
  * quis nostrud exercitation ullamco laboris nisi ut aliq W3C Software Notice
- * and License: https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ * and License: https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.
  */
 "
 `;

tests/paragraph.test.js

@@ -241,7 +241,8 @@ test("numbers and code in description", () => {
 `);
  expect(result2).toMatchSnapshot();
 
- const result3 = subject(`
+ const result3 = subject(
+ `
 /**
 * The script uses two heuristics to determine whether the keyboard is being used:
 *
@@ -254,7 +255,18 @@ test("numbers and code in description", () => {
 * W3C Software Notice and License: https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
 *
 */
-`);
+`,
+ {
+ jsdocDescriptionWithDot: true,
+ },
+ );
+
+ expect(
+ subject(result3, {
+ jsdocDescriptionWithDot: true,
+ }),
+ ).toEqual(result3);
+
  expect(result3).toMatchSnapshot();
 });
 
@@ -444,6 +456,32 @@ test("empty lines", () => {
  expect(result1).toMatchSnapshot();
 });
 
+test("Germany description with dot", () => {
+ const result = subject(
+ `/**
+
+* Wir brauchen hier eine effizientere Lösung. Die generierten Dateien sind zu groß
+
+*
+* Wir brauchen hier eine effizientere Lösung. Die generierten Dateien sind zu 3434
+
+*
+
+
+* @description Wir brauchen hier eine effizientere Lösung. Die generierten Dateien sind zu groß
+
+
+* @param a ssss
+
+*/`,
+ {
+ jsdocDescriptionWithDot: true,
+ },
+ );
+
+ expect(result).toMatchSnapshot();
+});
+
 /**
  * If this is a vertical ScrollView scrolls to the bottom.
  * If this is a horizontal ScrollView scrolls to the right.