{"id":50487773,"url":"https://github.com/lightpohl/node-md-meta-cataloger","last_synced_at":"2026-06-02T00:01:01.452Z","repository":{"id":57311453,"uuid":"145187136","full_name":"lightpohl/node-md-meta-cataloger","owner":"lightpohl","description":"A module and CLI for parsing Markdown files (including YAML Front Matter metadata).","archived":false,"fork":false,"pushed_at":"2023-08-09T02:43:07.000Z","size":140,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-10T17:11:33.547Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lightpohl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-08-18T03:35:49.000Z","updated_at":"2024-10-06T16:58:12.000Z","dependencies_parsed_at":"2022-09-10T21:13:36.655Z","dependency_job_id":"efcfcf25-924a-49e6-a692-9b047437ce11","html_url":"https://github.com/lightpohl/node-md-meta-cataloger","commit_stats":{"total_commits":45,"total_committers":2,"mean_commits":22.5,"dds":"0.022222222222222254","last_synced_commit":"9c026e7c323334ecaeac37d6d239dc6680780933"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/lightpohl/node-md-meta-cataloger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightpohl%2Fnode-md-meta-cataloger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightpohl%2Fnode-md-meta-cataloger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightpohl%2Fnode-md-meta-cataloger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightpohl%2Fnode-md-meta-cataloger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightpohl","download_url":"https://codeload.github.com/lightpohl/node-md-meta-cataloger/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightpohl%2Fnode-md-meta-cataloger/sbom","scorecard":{"id":589260,"data":{"date":"2025-08-11","repo":{"name":"github.com/lightpohl/node-md-meta-cataloger","commit":"9c026e7c323334ecaeac37d6d239dc6680780933"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T21:24:45.913Z","repository_id":57311453,"created_at":"2025-08-20T21:24:45.913Z","updated_at":"2025-08-20T21:24:45.913Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33798943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-02T00:01:00.151Z","updated_at":"2026-06-02T00:01:01.444Z","avatar_url":"https://github.com/lightpohl.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-md-meta-cataloger\n\n## Easily generate a JSON array of markdown files and their inline metadata.\n\n## Installation\n\n`npm install --save node-md-meta-cataloger`\n\n## How to Use\n\n### CLI Tool\n\n`node-md-meta-cataloger -i \u003cdir\u003e -o \u003cpath\u003e`\n\n`node-md-meta-cataloger -i /path/to/folder -o /another/path/catalog.json`\n\n`node-md-meta-cataloger --help`\n\n| Option                | Short Flag | Required | Description                           |\n| --------------------- | ---------- | -------- | ------------------------------------- |\n| --input \\\u003cdir\\\u003e       | -i         | true     | input directory path                  |\n| --output \\\u003cdir\\\u003e      | -o         | true     | output path of JSON result            |\n| --delete-filename-ext | -d         | false    | remove \".md\" from filenames in result |\n| --config              | -c         | false    | path to .js config file               |\n| --version             | -v         | false    | output the version number             |\n| --help                | -h         | false    | output usage information              |\n\n#### Config File (--config)\n\n-   Using the `--config` option you can specify a path to a JS config file (an ES module) that should return a default object exported with \"camelCased\" versions of the existing CLI options (plus any extra).\n-   If an option exists in both the config file and as a CLI option, then the CLI option will receive priority.\n\n| Option            | Type     | Required | Description                                              |\n| ----------------- | -------- | -------- | -------------------------------------------------------- |\n| input             | String   | true     | input directory path                                     |\n| output            | String   | true     | output path of JSON result                               |\n| normalize         | Function | false    | receives results as param, returned object is new result |\n| sort              | Function | false    | function for `sort`                                      |\n| deleteFilenameExt | Boolean  | false    | remove \".md\" from filenames in result if true            |\n\n### Node Module\n\n#### `readMarkdown(path: String): Promise\u003cArray|Object\u003e`\n\nPath parameter may reference a markdown file or folder containing markdown files.\n\n1. If passed a path to a folder, it returns a promise that resolves to an array of objects containing all markdown file content and their associated metadata.\n2. If passed a path to a file, it return a promise that resolves to an object containing the markdown content and its metadata.\n\n```js\nimport {readMarkdown} from 'node-md-meta-cataloger';\n\nconst result = await readMarkdown('path/to/folder');\n```\n\nExample value of `result` above:\n\n```js\n[\n    {\n        content: '\u003cp\u003emarkdown content\u003c/p\u003e',\n        filename: 'example.md',\n        filepath: 'path/to/folder/example.md',\n        metadata: {\n            title: 'Title',\n            author: 'Joshua',\n        },\n    },\n];\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightpohl%2Fnode-md-meta-cataloger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightpohl%2Fnode-md-meta-cataloger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightpohl%2Fnode-md-meta-cataloger/lists"}