Merge pull request #144 from Nosto/docs-cleanup

Modularize docs

package.json

@@ -58,15 +58,14 @@
         "build:liquid": "cp src/defaults/autocomplete.liquid dist/liquid/autocomplete.liquid",
         "build:mustache": "cp src/defaults/autocomplete.mustache dist/mustache/autocomplete.mustache",
         "build:styles": "cp src/styles.css dist/styles.css",
-        "build:docs": "typedoc src/index.ts",
+        "build:docs": "typedoc src/entries/base.ts src/entries/liquid.ts src/entries/mustache.ts src/entries/react.ts",
         "build:site": "npm run build:docs && npm run test:cov && rm -rf site && cp -r ./docs ./site && cp -r ./coverage ./site/coverage",
         "lint": "eslint 'src/**/*.{ts,tsx}' --cache",
         "typecheck": "tsc --noEmit",
         "exportTemplates": "node scripts/exportTemplates.js",
         "prettify": "prettier --write \"{src,spec}/**/*.{ts,tsx}\"",
         "test": "jest spec",
-        "test:cov": "jest --coverage spec && make-coverage-badge",
-        "dev:docs": "typedoc --watch src/index.ts"
+        "test:cov": "jest --coverage spec && make-coverage-badge"
     },
     "prettier": {
         "trailingComma": "es5",

scripts/exportTemplates.js

@@ -11,10 +11,11 @@ function generateTemplate(filePath, exportName) {
     return templateLinesWithConst;
 }
 
+const hidden = "/** @hidden */"
 const liquidTemplate = generateTemplate("./src/defaults/autocomplete.liquid", "defaultLiquidTemplate");
 const mustacheTemplate = generateTemplate("./src/defaults/autocomplete.mustache", "defaultMustacheTemplate");
 
 fs.writeFileSync(
     "./src/defaults/_generated.ts",
-    liquidTemplate + `\n` + mustacheTemplate
+    [hidden, liquidTemplate, hidden, mustacheTemplate].join("\n")
 );

src/config.ts

@@ -78,6 +78,17 @@ export interface AutocompleteConfig<State> {
   googleAnalytics?: GoogleAnalyticsConfig | boolean
   /**
    * Decorate each search hit before rendering
+   * 
+   * @example
+   * ```ts
+   * import { priceDecorator } from "@nosto/autocomplete"
+   * 
+   * autocomplete({
+   *   hitDecorators: [
+   *     priceDecorator({ defaultCurrency: "USD" })
+   *   ]
+   * })
+   * ```
    */
   hitDecorators?: HitDecorator[]
 }

src/defaults/Autocomplete.tsx

@@ -1,3 +1,4 @@
+/** @module react */
 import type { SearchKeyword, SearchProduct } from "@nosto/nosto-js/client"
 
 export interface AutocompleteProps {

src/defaults/_generated.ts

@@ -1,3 +1,4 @@
+/** @hidden */
 export const defaultLiquidTemplate = `
 {% assign hasKeywords = response.keywords.hits.length > 0 %}
 {% assign hasProducts = response.products.hits.length > 0 %}
@@ -98,6 +99,7 @@ export const defaultLiquidTemplate = `
 </div>
 `
 
+/** @hidden */
 export const defaultMustacheTemplate = `
 <div class="ns-autocomplete-results">
   {{#response.keywords.hits.length}}

src/entries/base.ts

@@ -1,3 +1,4 @@
+/** @module ./ */
 export { autocomplete, type AutocompleteInstance } from "../autocomplete"
 export { search } from "../search"
 export { type AutocompleteConfig, type GoogleAnalyticsConfig } from "../config"

src/entries/liquid.ts

@@ -1,3 +1,4 @@
+/** @module liquid */
 export {
   fromLiquidTemplate,
   fromRemoteLiquidTemplate,

src/entries/mustache.ts

@@ -1,3 +1,4 @@
+/** @module mustache */
 export {
   fromMustacheTemplate,
   fromRemoteMustacheTemplate,

src/entries/react.ts

@@ -1,2 +1,3 @@
+/** @module react */
 export { Autocomplete, type AutocompleteProps } from "../defaults/Autocomplete"
 export * from "./base"

src/search-js/decorator.ts

@@ -10,6 +10,7 @@ type FormattedPrices = {
 
 /**
  * Exposes currency formatting logic as a SearchProduct decorator
+ * Sets priceText and listPriceText fields on product and SKU level
  */
 export function priceDecorator(config?: Partial<CurrencyConfig>) {
   const { formatCurrency } = getCurrencyFormatting(config)