{"id":22428397,"url":"https://github.com/momsfriendlydevco/lawyers.txt","last_synced_at":"2025-03-27T06:43:42.921Z","repository":{"id":232810638,"uuid":"771891392","full_name":"MomsFriendlyDevCo/lawyers.txt","owner":"MomsFriendlyDevCo","description":"Lawyers.txt file generation","archived":false,"fork":false,"pushed_at":"2024-03-14T06:24:58.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T12:50:55.041Z","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/MomsFriendlyDevCo.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-14T06:24:36.000Z","updated_at":"2024-03-15T02:35:27.000Z","dependencies_parsed_at":"2024-04-11T16:11:26.769Z","dependency_job_id":"d05f3a1a-330e-4efb-bcd1-7970e6462f7d","html_url":"https://github.com/MomsFriendlyDevCo/lawyers.txt","commit_stats":null,"previous_names":["momsfriendlydevco/lawyers.txt"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Flawyers.txt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Flawyers.txt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Flawyers.txt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Flawyers.txt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MomsFriendlyDevCo","download_url":"https://codeload.github.com/MomsFriendlyDevCo/lawyers.txt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245798538,"owners_count":20673901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-12-05T20:14:42.324Z","updated_at":"2025-03-27T06:43:42.903Z","avatar_url":"https://github.com/MomsFriendlyDevCo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"@MomsFriendlyDevCo/Lawyers.txt\n==============================\nSimple [Supabase like](https://supabase.com/lawyers.txt) lawyers.txt generation for easy inclusion within projects.\n\nThis project exports a single string which can be glued into static files when generated.\n\nIt can also be run as `lawyers` from any project its installed in:\n\n```javascript\nimport {dirName} from '@momsfriendlydevco/es6'; // Or work out where we are somehow\nimport lawyers from '@momsfriendlydevco/lawyers.txt';\n\nlet lawyersSpeil = await lawyers({\n    path: dirName(),\n});\n\n// ...Do something with the string\n```\n\n\nAuto generation within a Vite project\n-------------------------------------\nThe following is an example of how to generate + output a `lawyers.txt` file using [vite-plugin-inject](https://www.npmjs.com/package/vite-plugin-inject) NPM:\n\n```javascript\n// Within vite.config.js\nimport {dirName} from '@momsfriendlydevco/es6';\nimport pluginInject from 'vite-plugin-inject';\nimport lawyers from '@momsfriendlydevco/lawyers.txt';\n\nexport default {\n    plugins: [\n        pluginInject([\n            /* ... other plugin config ... */\n            {\n                name: 'lawyers.txt',\n                async content() {\n                    return await lawyer({\n                        path: dirName(),\n                    });\n                },\n            },\n        ])\n    ],\n}\n```\n\n\nExample Output\n--------------\n\n```\nLawyers.txt\n-----------\nFor compliance.\n\nIf you're a creator/contributor to one of these packages, thanks!\n\nLast Updated: 2024-03-14\n\n# Package Name License Version                 Repository\n- ------------ ------- ----------------------- ----------------------------------------\n1 list-it      MIT     1.3.12                  https://github.com/takamin/list-it\n2 nlf          MIT     2.1.1                   http://github.com/iandotkelly/nlf\n3 node-getopt  MIT     0.3.3-forked-by-takamin https://github.com/jiangmiao/node-getopt\n```\n\n\nAPI\n===\n\nlawyers(options)\n----------------\nThis project exports a single function which takes the root path to scan from and some additional options.\nIt returns a promise which resolves to a String when generation has completed.\n\nSupported options are:\n\n| Option        | Type            | Default         | Description                                    |\n|---------------|-----------------|-----------------|------------------------------------------------|\n| `path`        | String          | `process.cwd()` | The path to start scanning from                |\n| `exclude`     | Array\u003cString\u003e ` | `[]`            | Array of packages to exclude, by name          |\n| `excludeSelf` | `true`          | `true`          | Exclude the named package in the starting path |\n| `depth`       | `Number`        | `1`             | Package depth to scan                          |\n| `production`  | `Boolean`       | `true`          | Only show production level packages            |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmomsfriendlydevco%2Flawyers.txt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmomsfriendlydevco%2Flawyers.txt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmomsfriendlydevco%2Flawyers.txt/lists"}