Add help texts for all options, bump version

Author: klntsky

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
 
       - uses: actions/setup-node@v2
         with:
-          node-version: "14"
+          node-version: "18"
 
       - uses: purescript-contrib/setup-purescript@main
 
@@ -41,4 +41,4 @@ jobs:
           npm run build
           npm test
           spago docs --no-search
-          ./dist/purescript-docs-search build-index
+          ./dist/purescript-docs-search.cjs build-index

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
 
       - uses: actions/setup-node@v2
         with:
-          node-version: "14"
+          node-version: "18"
 
       - uses: purescript-contrib/setup-purescript@main
 
@@ -41,7 +41,7 @@ jobs:
         with:
           files: |
             dist/docs-search-app.js
-            dist/purescript-docs-search
+            dist/purescript-docs-search.cjs
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -52,4 +52,4 @@ jobs:
         run: |
           mv ci-npmrc.txt .npmrc
           npm ci
-          npm publish --non-interactive --access public
+          npm publish --non-interactive --access public

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.12 - 2022-08-31]
+
+Changes:
+- Package structure change: `dist/purescript-docs-search.cjs` has been moved to `dist/purescript-docs-search.cjs` due to NodeJS restrictions for `type: module` packages.
+
+New features:
+- Docs for each CLI option
+- New `--source-files` option that allows to specify `.purs` sources (see below)
+
+Bugfixes:
+- Include modules with only re-exports in the module list ([#62](https://github.com/purescript/purescript-docs-search/issues/62))
+- Fix `docs.json` parser for some types
+
 ## [0.0.11 - 2021-04-15]
 
 Changes:

package.json

@@ -1,7 +1,7 @@
 {
   "name": "purescript-docs-search",
   "type": "module",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Search frontend for the documentation generated by the PureScript compiler.",
   "directories": {
     "test": "test"

src/Docs/Search/Config.purs

@@ -7,7 +7,7 @@ import Prelude
 import Data.Newtype (wrap)
 
 version :: String
-version = "0.0.11"
+version = "0.0.12"
 
 mkShapeScriptPath :: String -> String
 mkShapeScriptPath shape = "./index/types/" <> shape <> ".js"

src/Docs/Search/IndexBuilder.purs

@@ -192,6 +192,10 @@ decodeDocsJsons cfg@{ docsFiles } = do
 parseModuleHeaders :: Array String -> Aff (Array ModuleName)
 parseModuleHeaders globs = do
   files <- getPathsByGlobs globs
+
+  -- we are not checking if the globs match at least one file, because
+  -- we want to support scenarios where there is no "current project"
+
   concat <$> for files \filePath -> do
     fileContents <- readTextFile UTF8 filePath
     case parseModuleName fileContents of

src/Docs/Search/Main.purs

@@ -1,19 +1,19 @@
 -- | The main module of the CLI interface app.
 module Docs.Search.Main where
 
-import Prelude
-
+import Docs.Search.Config as Config
 import Docs.Search.IndexBuilder as IndexBuilder
 import Docs.Search.Interactive as Interactive
-import Docs.Search.Config as Config
 import Docs.Search.Types (PackageName(..))
 
+import Prelude
+
 import Data.Generic.Rep (class Generic)
-import Data.Show.Generic (genericShow)
 import Data.List as List
 import Data.List.NonEmpty as NonEmpty
 import Data.Maybe (Maybe, fromMaybe, optional)
 import Data.Newtype (unwrap)
+import Data.Show.Generic (genericShow)
 import Data.Unfoldable (class Unfoldable)
 import Effect (Effect)
 import Effect.Console (log)
@@ -85,6 +85,7 @@ buildIndex = ado
     ( long "generated-docs"
    <> metavar "DIR"
    <> value "./generated-docs/"
+   <> help "Path to the generated documentation HTML that will be patched. Search app will be injected into each HTML document."
     )
   noPatch <- flag false true
     ( long "no-patch"
@@ -108,6 +109,7 @@ docsFilesOption = fromMaybe defaultDocsFiles <$>
      ( strOption
        ( long "docs-files"
       <> metavar "GLOB"
+      <> help "Glob that captures `docs.json` files that should be used to build the index"
        )
      )
    )
@@ -119,6 +121,7 @@ bowerFilesOption = fromMaybe defaultBowerFiles <$>
      ( strOption
        ( long "bower-jsons"
       <> metavar "GLOB"
+      <> help "Glob that captures `bower.json` files. These files are used to build dependency trees to compute package popularity scores based on how many dependants a package has."
        )
      )
    )
@@ -129,6 +132,7 @@ packageNameOption =
   ( long "package-name"
  <> metavar "PACKAGE"
  <> value (unwrap Config.defaultPackageName)
+ <> help "Local package name as it should appear in the search results"
   )
 
 sourceFilesOption :: Parser (Array String)
@@ -138,6 +142,7 @@ sourceFilesOption = fromMaybe defaultSourceFiles <$>
      ( strOption
        ( long "source-files"
       <> metavar "GLOB"
+      <> help "Path to project source files, used for more precise module indexing (see #62). Default: src/**/*.purs"
        )
      )
    )