fix(prettier-plugin-jsdoc): add support for the remarks tag

homer0 · Mar 16, 2021 · fb2835f · fb2835f
1 parent 50f3d12
commit fb2835f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/fns/constants.js b/src/fns/constants.js
@@ -50,6 +50,7 @@ const getTagsWithDescriptionAsName = () => [
   'examples',
   'file',
   'license',
+  'remarks',
   'summary',
   'throws',
   'todo',

diff --git a/test/e2e/fixtures/random-01.fixture.js b/test/e2e/fixtures/random-01.fixture.js
@@ -39,6 +39,10 @@ const log = (name = 'batman', logger) => {};
  * @parent module:controllers
  */
 
+/**
+ * @remarks Some of the Prisma scalars do not have a natural standard representation in GraphQL. For these case Nexus Prisma generates code that references type names matching those scalar names in Prisma. Then, you are expected to define those custom scalar types in your GraphQL API.
+ */
+
 //# output
 
 /**
@@ -101,3 +105,10 @@ const log = (name = 'batman', logger) => {};
  * StaticsControllerWrapperOptions
  * @parent module:controllers
  */
+
+/**
+ * @remarks Some of the Prisma scalars do not have a natural standard representation in
+ *          GraphQL. For these case Nexus Prisma generates code that references type names
+ *          matching those scalar names in Prisma. Then, you are expected to define those
+ *          custom scalar types in your GraphQL API.
+ */