data-analyst-mcp 0.0.0-stage → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +261 -2
- package/dist/adapters/_acf_tidy.d.ts +18 -0
- package/dist/adapters/_acf_tidy.js +432 -0
- package/dist/adapters/_acf_tidy.js.map +1 -0
- package/dist/adapters/_actuaries_read.d.ts +38 -0
- package/dist/adapters/_actuaries_read.js +728 -0
- package/dist/adapters/_actuaries_read.js.map +1 -0
- package/dist/adapters/_census_micro.d.ts +70 -0
- package/dist/adapters/_census_micro.js +622 -0
- package/dist/adapters/_census_micro.js.map +1 -0
- package/dist/adapters/_census_util.d.ts +40 -0
- package/dist/adapters/_census_util.js +275 -0
- package/dist/adapters/_census_util.js.map +1 -0
- package/dist/adapters/_dol_states.d.ts +6 -0
- package/dist/adapters/_dol_states.js +58 -0
- package/dist/adapters/_dol_states.js.map +1 -0
- package/dist/adapters/_govinfo_entities.d.ts +4 -0
- package/dist/adapters/_govinfo_entities.js +6 -0
- package/dist/adapters/_govinfo_entities.js.map +1 -0
- package/dist/adapters/_govinfo_json.d.ts +13 -0
- package/dist/adapters/_govinfo_json.js +107 -0
- package/dist/adapters/_govinfo_json.js.map +1 -0
- package/dist/adapters/_govinfo_py.d.ts +22 -0
- package/dist/adapters/_govinfo_py.js +272 -0
- package/dist/adapters/_govinfo_py.js.map +1 -0
- package/dist/adapters/_govinfo_xml.d.ts +22 -0
- package/dist/adapters/_govinfo_xml.js +233 -0
- package/dist/adapters/_govinfo_xml.js.map +1 -0
- package/dist/adapters/_hud_excel.d.ts +2 -0
- package/dist/adapters/_hud_excel.js +166 -0
- package/dist/adapters/_hud_excel.js.map +1 -0
- package/dist/adapters/_omb_grid.d.ts +17 -0
- package/dist/adapters/_omb_grid.js +132 -0
- package/dist/adapters/_omb_grid.js.map +1 -0
- package/dist/adapters/_omb_util.d.ts +40 -0
- package/dist/adapters/_omb_util.js +192 -0
- package/dist/adapters/_omb_util.js.map +1 -0
- package/dist/adapters/_usaspending_state.d.ts +6 -0
- package/dist/adapters/_usaspending_state.js +54 -0
- package/dist/adapters/_usaspending_state.js.map +1 -0
- package/dist/adapters/_usda-fna_book.d.ts +59 -0
- package/dist/adapters/_usda-fna_book.js +869 -0
- package/dist/adapters/_usda-fna_book.js.map +1 -0
- package/dist/adapters/_usda-fna_pdf.d.ts +20 -0
- package/dist/adapters/_usda-fna_pdf.js +361 -0
- package/dist/adapters/_usda-fna_pdf.js.map +1 -0
- package/dist/adapters/_usda-outlook_read.d.ts +70 -0
- package/dist/adapters/_usda-outlook_read.js +362 -0
- package/dist/adapters/_usda-outlook_read.js.map +1 -0
- package/dist/adapters/acf.d.ts +3 -0
- package/dist/adapters/acf.js +187 -0
- package/dist/adapters/acf.js.map +1 -0
- package/dist/adapters/actuaries.d.ts +3 -0
- package/dist/adapters/actuaries.js +293 -0
- package/dist/adapters/actuaries.js.map +1 -0
- package/dist/adapters/bts.d.ts +3 -0
- package/dist/adapters/bts.js +26 -0
- package/dist/adapters/bts.js.map +1 -0
- package/dist/adapters/census-geocoder.d.ts +10 -0
- package/dist/adapters/census-geocoder.js +47 -0
- package/dist/adapters/census-geocoder.js.map +1 -0
- package/dist/adapters/census.d.ts +17 -0
- package/dist/adapters/census.js +983 -0
- package/dist/adapters/census.js.map +1 -0
- package/dist/adapters/cfpb.d.ts +7 -0
- package/dist/adapters/cfpb.js +348 -0
- package/dist/adapters/cfpb.js.map +1 -0
- package/dist/adapters/clinical-trials.d.ts +3 -0
- package/dist/adapters/clinical-trials.js +135 -0
- package/dist/adapters/clinical-trials.js.map +1 -0
- package/dist/adapters/cms.d.ts +3 -0
- package/dist/adapters/cms.js +292 -0
- package/dist/adapters/cms.js.map +1 -0
- package/dist/adapters/college-scorecard.d.ts +3 -0
- package/dist/adapters/college-scorecard.js +122 -0
- package/dist/adapters/college-scorecard.js.map +1 -0
- package/dist/adapters/congress.d.ts +33 -0
- package/dist/adapters/congress.js +589 -0
- package/dist/adapters/congress.js.map +1 -0
- package/dist/adapters/dhs-ohss.d.ts +13 -0
- package/dist/adapters/dhs-ohss.js +598 -0
- package/dist/adapters/dhs-ohss.js.map +1 -0
- package/dist/adapters/doj-news.d.ts +7 -0
- package/dist/adapters/doj-news.js +286 -0
- package/dist/adapters/doj-news.js.map +1 -0
- package/dist/adapters/dol.d.ts +4 -0
- package/dist/adapters/dol.js +634 -0
- package/dist/adapters/dol.js.map +1 -0
- package/dist/adapters/eia.d.ts +15 -0
- package/dist/adapters/eia.js +456 -0
- package/dist/adapters/eia.js.map +1 -0
- package/dist/adapters/epa-aqs.d.ts +3 -0
- package/dist/adapters/epa-aqs.js +357 -0
- package/dist/adapters/epa-aqs.js.map +1 -0
- package/dist/adapters/epa.d.ts +3 -0
- package/dist/adapters/epa.js +298 -0
- package/dist/adapters/epa.js.map +1 -0
- package/dist/adapters/fbi.d.ts +3 -0
- package/dist/adapters/fbi.js +192 -0
- package/dist/adapters/fbi.js.map +1 -0
- package/dist/adapters/fda.d.ts +5 -0
- package/dist/adapters/fda.js +184 -0
- package/dist/adapters/fda.js.map +1 -0
- package/dist/adapters/fdic.d.ts +4 -0
- package/dist/adapters/fdic.js +95 -0
- package/dist/adapters/fdic.js.map +1 -0
- package/dist/adapters/fec.d.ts +3 -0
- package/dist/adapters/fec.js +142 -0
- package/dist/adapters/fec.js.map +1 -0
- package/dist/adapters/fed-board.d.ts +12 -0
- package/dist/adapters/fed-board.js +581 -0
- package/dist/adapters/fed-board.js.map +1 -0
- package/dist/adapters/federal-register.d.ts +11 -0
- package/dist/adapters/federal-register.js +43 -0
- package/dist/adapters/federal-register.js.map +1 -0
- package/dist/adapters/fhfa.d.ts +3 -0
- package/dist/adapters/fhfa.js +253 -0
- package/dist/adapters/fhfa.js.map +1 -0
- package/dist/adapters/fsa.d.ts +9 -0
- package/dist/adapters/fsa.js +335 -0
- package/dist/adapters/fsa.js.map +1 -0
- package/dist/adapters/govinfo.d.ts +30 -0
- package/dist/adapters/govinfo.js +636 -0
- package/dist/adapters/govinfo.js.map +1 -0
- package/dist/adapters/gsa-calc.d.ts +10 -0
- package/dist/adapters/gsa-calc.js +318 -0
- package/dist/adapters/gsa-calc.js.map +1 -0
- package/dist/adapters/hud.d.ts +3 -0
- package/dist/adapters/hud.js +200 -0
- package/dist/adapters/hud.js.map +1 -0
- package/dist/adapters/index.d.ts +3 -0
- package/dist/adapters/index.js +25 -0
- package/dist/adapters/index.js.map +1 -0
- package/dist/adapters/irs-soi.d.ts +6 -0
- package/dist/adapters/irs-soi.js +576 -0
- package/dist/adapters/irs-soi.js.map +1 -0
- package/dist/adapters/naep.d.ts +15 -0
- package/dist/adapters/naep.js +341 -0
- package/dist/adapters/naep.js.map +1 -0
- package/dist/adapters/nhtsa.d.ts +10 -0
- package/dist/adapters/nhtsa.js +239 -0
- package/dist/adapters/nhtsa.js.map +1 -0
- package/dist/adapters/nih.d.ts +5 -0
- package/dist/adapters/nih.js +196 -0
- package/dist/adapters/nih.js.map +1 -0
- package/dist/adapters/noaa.d.ts +3 -0
- package/dist/adapters/noaa.js +148 -0
- package/dist/adapters/noaa.js.map +1 -0
- package/dist/adapters/nrel.d.ts +3 -0
- package/dist/adapters/nrel.js +186 -0
- package/dist/adapters/nrel.js.map +1 -0
- package/dist/adapters/nws.d.ts +3 -0
- package/dist/adapters/nws.js +119 -0
- package/dist/adapters/nws.js.map +1 -0
- package/dist/adapters/omb.d.ts +15 -0
- package/dist/adapters/omb.js +517 -0
- package/dist/adapters/omb.js.map +1 -0
- package/dist/adapters/open-payments.d.ts +5 -0
- package/dist/adapters/open-payments.js +149 -0
- package/dist/adapters/open-payments.js.map +1 -0
- package/dist/adapters/pbgc.d.ts +13 -0
- package/dist/adapters/pbgc.js +283 -0
- package/dist/adapters/pbgc.js.map +1 -0
- package/dist/adapters/philfed.d.ts +12 -0
- package/dist/adapters/philfed.js +59 -0
- package/dist/adapters/philfed.js.map +1 -0
- package/dist/adapters/regulations.d.ts +6 -0
- package/dist/adapters/regulations.js +58 -0
- package/dist/adapters/regulations.js.map +1 -0
- package/dist/adapters/sec.d.ts +13 -0
- package/dist/adapters/sec.js +504 -0
- package/dist/adapters/sec.js.map +1 -0
- package/dist/adapters/senate-lobbying.d.ts +3 -0
- package/dist/adapters/senate-lobbying.js +181 -0
- package/dist/adapters/senate-lobbying.js.map +1 -0
- package/dist/adapters/snapqc.d.ts +32 -0
- package/dist/adapters/snapqc.js +701 -0
- package/dist/adapters/snapqc.js.map +1 -0
- package/dist/adapters/treasury-yields.d.ts +3 -0
- package/dist/adapters/treasury-yields.js +170 -0
- package/dist/adapters/treasury-yields.js.map +1 -0
- package/dist/adapters/usaspending.d.ts +3 -0
- package/dist/adapters/usaspending.js +340 -0
- package/dist/adapters/usaspending.js.map +1 -0
- package/dist/adapters/usda-fna.d.ts +7 -0
- package/dist/adapters/usda-fna.js +707 -0
- package/dist/adapters/usda-fna.js.map +1 -0
- package/dist/adapters/usda-fooddata.d.ts +3 -0
- package/dist/adapters/usda-fooddata.js +101 -0
- package/dist/adapters/usda-fooddata.js.map +1 -0
- package/dist/adapters/usda-nass.d.ts +3 -0
- package/dist/adapters/usda-nass.js +108 -0
- package/dist/adapters/usda-nass.js.map +1 -0
- package/dist/adapters/usda-outlook.d.ts +12 -0
- package/dist/adapters/usda-outlook.js +696 -0
- package/dist/adapters/usda-outlook.js.map +1 -0
- package/dist/adapters/usgs.d.ts +9 -0
- package/dist/adapters/usgs.js +265 -0
- package/dist/adapters/usgs.js.map +1 -0
- package/dist/adapters/usitc.d.ts +18 -0
- package/dist/adapters/usitc.js +170 -0
- package/dist/adapters/usitc.js.map +1 -0
- package/dist/adapters/uspto.d.ts +3 -0
- package/dist/adapters/uspto.js +47 -0
- package/dist/adapters/uspto.js.map +1 -0
- package/dist/adapters/world-bank.d.ts +3 -0
- package/dist/adapters/world-bank.js +163 -0
- package/dist/adapters/world-bank.js.map +1 -0
- package/dist/analysis/cite.d.ts +31 -0
- package/dist/analysis/cite.js +229 -0
- package/dist/analysis/cite.js.map +1 -0
- package/dist/analysis/combine.d.ts +27 -0
- package/dist/analysis/combine.js +198 -0
- package/dist/analysis/combine.js.map +1 -0
- package/dist/analysis/compute.d.ts +62 -0
- package/dist/analysis/compute.js +583 -0
- package/dist/analysis/compute.js.map +1 -0
- package/dist/analysis/expr.d.ts +69 -0
- package/dist/analysis/expr.js +780 -0
- package/dist/analysis/expr.js.map +1 -0
- package/dist/analysis/factfmt.d.ts +16 -0
- package/dist/analysis/factfmt.js +187 -0
- package/dist/analysis/factfmt.js.map +1 -0
- package/dist/analysis/facts.d.ts +63 -0
- package/dist/analysis/facts.js +355 -0
- package/dist/analysis/facts.js.map +1 -0
- package/dist/analysis/handoff.d.ts +58 -0
- package/dist/analysis/handoff.js +208 -0
- package/dist/analysis/handoff.js.map +1 -0
- package/dist/analysis/pyfmt.d.ts +16 -0
- package/dist/analysis/pyfmt.js +156 -0
- package/dist/analysis/pyfmt.js.map +1 -0
- package/dist/analysis/rerun.d.ts +13 -0
- package/dist/analysis/rerun.js +125 -0
- package/dist/analysis/rerun.js.map +1 -0
- package/dist/analysis/table.d.ts +18 -0
- package/dist/analysis/table.js +109 -0
- package/dist/analysis/table.js.map +1 -0
- package/dist/analysis/tools.d.ts +67 -0
- package/dist/analysis/tools.js +217 -0
- package/dist/analysis/tools.js.map +1 -0
- package/dist/analysis/write_table.d.ts +13 -0
- package/dist/analysis/write_table.js +59 -0
- package/dist/analysis/write_table.js.map +1 -0
- package/dist/bin/cli.d.ts +10 -0
- package/dist/bin/cli.js +177 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/core/cache.d.ts +14 -0
- package/dist/core/cache.js +90 -0
- package/dist/core/cache.js.map +1 -0
- package/dist/core/context.d.ts +12 -0
- package/dist/core/context.js +15 -0
- package/dist/core/context.js.map +1 -0
- package/dist/core/env.d.ts +14 -0
- package/dist/core/env.js +52 -0
- package/dist/core/env.js.map +1 -0
- package/dist/core/generic-rest.d.ts +61 -0
- package/dist/core/generic-rest.js +639 -0
- package/dist/core/generic-rest.js.map +1 -0
- package/dist/core/http.d.ts +120 -0
- package/dist/core/http.js +514 -0
- package/dist/core/http.js.map +1 -0
- package/dist/core/keys.d.ts +43 -0
- package/dist/core/keys.js +174 -0
- package/dist/core/keys.js.map +1 -0
- package/dist/core/manual.d.ts +41 -0
- package/dist/core/manual.js +218 -0
- package/dist/core/manual.js.map +1 -0
- package/dist/core/package.d.ts +58 -0
- package/dist/core/package.js +228 -0
- package/dist/core/package.js.map +1 -0
- package/dist/core/packs.d.ts +139 -0
- package/dist/core/packs.js +173 -0
- package/dist/core/packs.js.map +1 -0
- package/dist/core/policy.d.ts +69 -0
- package/dist/core/policy.js +189 -0
- package/dist/core/policy.js.map +1 -0
- package/dist/core/py.d.ts +40 -0
- package/dist/core/py.js +171 -0
- package/dist/core/py.js.map +1 -0
- package/dist/core/routing.d.ts +10 -0
- package/dist/core/routing.js +39 -0
- package/dist/core/routing.js.map +1 -0
- package/dist/core/tabular.d.ts +21 -0
- package/dist/core/tabular.js +229 -0
- package/dist/core/tabular.js.map +1 -0
- package/dist/deep/_bea_api.d.ts +102 -0
- package/dist/deep/_bea_api.js +457 -0
- package/dist/deep/_bea_api.js.map +1 -0
- package/dist/deep/_bea_fetch.d.ts +151 -0
- package/dist/deep/_bea_fetch.js +1274 -0
- package/dist/deep/_bea_fetch.js.map +1 -0
- package/dist/deep/_bea_util.d.ts +14 -0
- package/dist/deep/_bea_util.js +156 -0
- package/dist/deep/_bea_util.js.map +1 -0
- package/dist/deep/_bls_api.d.ts +84 -0
- package/dist/deep/_bls_api.js +231 -0
- package/dist/deep/_bls_api.js.map +1 -0
- package/dist/deep/_bls_ids.d.ts +43 -0
- package/dist/deep/_bls_ids.js +188 -0
- package/dist/deep/_bls_ids.js.map +1 -0
- package/dist/deep/_bls_lib.d.ts +61 -0
- package/dist/deep/_bls_lib.js +442 -0
- package/dist/deep/_bls_lib.js.map +1 -0
- package/dist/deep/_fred_api.d.ts +148 -0
- package/dist/deep/_fred_api.js +545 -0
- package/dist/deep/_fred_api.js.map +1 -0
- package/dist/deep/_fred_pack.d.ts +162 -0
- package/dist/deep/_fred_pack.js +1027 -0
- package/dist/deep/_fred_pack.js.map +1 -0
- package/dist/deep/_fred_py.d.ts +40 -0
- package/dist/deep/_fred_py.js +199 -0
- package/dist/deep/_fred_py.js.map +1 -0
- package/dist/deep/_ipums_bundle.d.ts +29 -0
- package/dist/deep/_ipums_bundle.js +194 -0
- package/dist/deep/_ipums_bundle.js.map +1 -0
- package/dist/deep/_ipums_ddi.d.ts +23 -0
- package/dist/deep/_ipums_ddi.js +162 -0
- package/dist/deep/_ipums_ddi.js.map +1 -0
- package/dist/deep/_opm_io.d.ts +26 -0
- package/dist/deep/_opm_io.js +383 -0
- package/dist/deep/_opm_io.js.map +1 -0
- package/dist/deep/_opm_parquet.d.ts +31 -0
- package/dist/deep/_opm_parquet.js +744 -0
- package/dist/deep/_opm_parquet.js.map +1 -0
- package/dist/deep/_opm_py.d.ts +6 -0
- package/dist/deep/_opm_py.js +74 -0
- package/dist/deep/_opm_py.js.map +1 -0
- package/dist/deep/_treasury_api.d.ts +48 -0
- package/dist/deep/_treasury_api.js +221 -0
- package/dist/deep/_treasury_api.js.map +1 -0
- package/dist/deep/_treasury_context.d.ts +34 -0
- package/dist/deep/_treasury_context.js +142 -0
- package/dist/deep/_treasury_context.js.map +1 -0
- package/dist/deep/_treasury_lib.d.ts +109 -0
- package/dist/deep/_treasury_lib.js +686 -0
- package/dist/deep/_treasury_lib.js.map +1 -0
- package/dist/deep/bea.d.ts +3 -0
- package/dist/deep/bea.js +248 -0
- package/dist/deep/bea.js.map +1 -0
- package/dist/deep/bls.d.ts +3 -0
- package/dist/deep/bls.js +220 -0
- package/dist/deep/bls.js.map +1 -0
- package/dist/deep/fred.d.ts +3 -0
- package/dist/deep/fred.js +325 -0
- package/dist/deep/fred.js.map +1 -0
- package/dist/deep/ipums.d.ts +59 -0
- package/dist/deep/ipums.js +744 -0
- package/dist/deep/ipums.js.map +1 -0
- package/dist/deep/opm.d.ts +56 -0
- package/dist/deep/opm.js +1033 -0
- package/dist/deep/opm.js.map +1 -0
- package/dist/deep/treasury.d.ts +3 -0
- package/dist/deep/treasury.js +218 -0
- package/dist/deep/treasury.js.map +1 -0
- package/dist/envelope.d.ts +47 -0
- package/dist/envelope.js +88 -0
- package/dist/envelope.js.map +1 -0
- package/dist/index.d.ts +277 -0
- package/dist/index.js +106 -0
- package/dist/index.js.map +1 -0
- package/dist/remote/app.d.ts +21 -0
- package/dist/remote/app.js +218 -0
- package/dist/remote/app.js.map +1 -0
- package/dist/remote/oauth.d.ts +14 -0
- package/dist/remote/oauth.js +90 -0
- package/dist/remote/oauth.js.map +1 -0
- package/dist/remote/pages.d.ts +8 -0
- package/dist/remote/pages.js +56 -0
- package/dist/remote/pages.js.map +1 -0
- package/dist/remote/sign.d.ts +4 -0
- package/dist/remote/sign.js +40 -0
- package/dist/remote/sign.js.map +1 -0
- package/dist/remote/store.d.ts +31 -0
- package/dist/remote/store.js +129 -0
- package/dist/remote/store.js.map +1 -0
- package/dist/report/audit_answer.d.ts +94 -0
- package/dist/report/audit_answer.js +1349 -0
- package/dist/report/audit_answer.js.map +1 -0
- package/dist/report/audit_report.d.ts +23 -0
- package/dist/report/audit_report.js +637 -0
- package/dist/report/audit_report.js.map +1 -0
- package/dist/report/build_report.d.ts +27 -0
- package/dist/report/build_report.js +1168 -0
- package/dist/report/build_report.js.map +1 -0
- package/dist/report/method_audit.d.ts +47 -0
- package/dist/report/method_audit.js +716 -0
- package/dist/report/method_audit.js.map +1 -0
- package/dist/report/policyset.d.ts +50 -0
- package/dist/report/policyset.js +421 -0
- package/dist/report/policyset.js.map +1 -0
- package/dist/report/py.d.ts +58 -0
- package/dist/report/py.js +311 -0
- package/dist/report/py.js.map +1 -0
- package/dist/report/scan_secrets.d.ts +24 -0
- package/dist/report/scan_secrets.js +265 -0
- package/dist/report/scan_secrets.js.map +1 -0
- package/dist/report/style_check.d.ts +29 -0
- package/dist/report/style_check.js +173 -0
- package/dist/report/style_check.js.map +1 -0
- package/dist/report/tools.d.ts +87 -0
- package/dist/report/tools.js +167 -0
- package/dist/report/tools.js.map +1 -0
- package/dist/server.d.ts +5 -0
- package/dist/server.js +247 -0
- package/dist/server.js.map +1 -0
- package/dist/session.d.ts +47 -0
- package/dist/session.js +107 -0
- package/dist/session.js.map +1 -0
- package/dist/toolkit.d.ts +21 -0
- package/dist/toolkit.js +2 -0
- package/dist/toolkit.js.map +1 -0
- package/dist/tools.d.ts +299 -0
- package/dist/tools.js +491 -0
- package/dist/tools.js.map +1 -0
- package/guide/WORKFLOW.md +134 -0
- package/guide/assets/disclaimer.txt +1 -0
- package/guide/assets/download_data.ps1 +162 -0
- package/guide/assets/download_data.sh +143 -0
- package/guide/assets/report_template.html +597 -0
- package/guide/references/report_patterns.md +199 -0
- package/guide/references/routing.md +171 -0
- package/guide/references/style_guide.md +398 -0
- package/package.json +54 -4
- package/packs/acf/endpoints.json +114 -0
- package/packs/acf/policy.json +104 -0
- package/packs/acf/source.md +138 -0
- package/packs/actuaries/endpoints.json +82 -0
- package/packs/actuaries/policy.json +109 -0
- package/packs/actuaries/source.md +137 -0
- package/packs/bea/assets/download_bea.ps1 +182 -0
- package/packs/bea/assets/download_bea.sh +144 -0
- package/packs/bea/docs/bea_api.md +461 -0
- package/packs/bea/docs/datasets.md +157 -0
- package/packs/bea/docs/report_patterns.md +112 -0
- package/packs/bea/policy.json +170 -0
- package/packs/bea/source.md +152 -0
- package/packs/bls/assets/download_bls.ps1 +152 -0
- package/packs/bls/assets/download_bls.sh +167 -0
- package/packs/bls/docs/analysis_patterns.md +108 -0
- package/packs/bls/docs/bls_api.md +73 -0
- package/packs/bls/docs/series_ids.md +149 -0
- package/packs/bls/policy.json +238 -0
- package/packs/bls/series_ids.json +1375 -0
- package/packs/bls/source.md +156 -0
- package/packs/bts/endpoints.json +347 -0
- package/packs/bts/policy.json +94 -0
- package/packs/bts/source.md +97 -0
- package/packs/cdc/endpoints.json +197 -0
- package/packs/cdc/policy.json +83 -0
- package/packs/cdc/source.md +74 -0
- package/packs/census/endpoints.json +99 -0
- package/packs/census/policy.json +238 -0
- package/packs/census/source.md +304 -0
- package/packs/census-geocoder/endpoints.json +70 -0
- package/packs/census-geocoder/policy.json +80 -0
- package/packs/census-geocoder/source.md +53 -0
- package/packs/cfpb/endpoints.json +327 -0
- package/packs/cfpb/policy.json +119 -0
- package/packs/cfpb/source.md +96 -0
- package/packs/clinical-trials/endpoints.json +167 -0
- package/packs/clinical-trials/policy.json +84 -0
- package/packs/clinical-trials/source.md +82 -0
- package/packs/cms/endpoints.json +69 -0
- package/packs/cms/policy.json +96 -0
- package/packs/cms/source.md +112 -0
- package/packs/college-scorecard/endpoints.json +253 -0
- package/packs/college-scorecard/policy.json +106 -0
- package/packs/college-scorecard/source.md +92 -0
- package/packs/congress/endpoints.json +1701 -0
- package/packs/congress/policy.json +117 -0
- package/packs/congress/source.md +190 -0
- package/packs/dhs-ohss/endpoints.json +66 -0
- package/packs/dhs-ohss/policy.json +107 -0
- package/packs/dhs-ohss/source.md +120 -0
- package/packs/doj-news/endpoints.json +59 -0
- package/packs/doj-news/policy.json +96 -0
- package/packs/doj-news/source.md +99 -0
- package/packs/dol/endpoints.json +818 -0
- package/packs/dol/policy.json +135 -0
- package/packs/dol/source.md +181 -0
- package/packs/eia/endpoints.json +718 -0
- package/packs/eia/policy.json +112 -0
- package/packs/eia/source.md +112 -0
- package/packs/epa/endpoints.json +292 -0
- package/packs/epa/policy.json +99 -0
- package/packs/epa/source.md +99 -0
- package/packs/epa-aqs/endpoints.json +174 -0
- package/packs/epa-aqs/policy.json +96 -0
- package/packs/epa-aqs/source.md +97 -0
- package/packs/fbi/endpoints.json +1842 -0
- package/packs/fbi/policy.json +118 -0
- package/packs/fbi/source.md +108 -0
- package/packs/fda/endpoints.json +238 -0
- package/packs/fda/policy.json +121 -0
- package/packs/fda/source.md +117 -0
- package/packs/fdic/endpoints.json +417 -0
- package/packs/fdic/policy.json +83 -0
- package/packs/fdic/source.md +92 -0
- package/packs/fec/endpoints.json +708 -0
- package/packs/fec/policy.json +93 -0
- package/packs/fec/source.md +90 -0
- package/packs/fed-board/endpoints.json +89 -0
- package/packs/fed-board/policy.json +136 -0
- package/packs/fed-board/source.md +118 -0
- package/packs/federal-register/endpoints.json +143 -0
- package/packs/federal-register/policy.json +86 -0
- package/packs/federal-register/source.md +98 -0
- package/packs/fema/endpoints.json +646 -0
- package/packs/fema/policy.json +103 -0
- package/packs/fema/source.md +103 -0
- package/packs/fhfa/endpoints.json +105 -0
- package/packs/fhfa/policy.json +109 -0
- package/packs/fhfa/source.md +108 -0
- package/packs/fred/assets/download_fred.ps1 +122 -0
- package/packs/fred/assets/download_fred.sh +123 -0
- package/packs/fred/docs/analysis_patterns.md +124 -0
- package/packs/fred/docs/fred_api.md +94 -0
- package/packs/fred/docs/series.md +188 -0
- package/packs/fred/policy.json +253 -0
- package/packs/fred/source.md +142 -0
- package/packs/fsa/endpoints.json +150 -0
- package/packs/fsa/policy.json +99 -0
- package/packs/fsa/source.md +102 -0
- package/packs/govinfo/endpoints.json +520 -0
- package/packs/govinfo/policy.json +116 -0
- package/packs/govinfo/source.md +241 -0
- package/packs/gsa-calc/endpoints.json +93 -0
- package/packs/gsa-calc/policy.json +97 -0
- package/packs/gsa-calc/source.md +108 -0
- package/packs/hud/endpoints.json +147 -0
- package/packs/hud/policy.json +84 -0
- package/packs/hud/source.md +97 -0
- package/packs/ipums/assets/download_ipums.ps1 +215 -0
- package/packs/ipums/assets/download_ipums.sh +192 -0
- package/packs/ipums/docs/ipums_api.md +67 -0
- package/packs/ipums/docs/report_patterns.md +117 -0
- package/packs/ipums/docs/variables.md +284 -0
- package/packs/ipums/lib/fetch_text.json +112 -0
- package/packs/ipums/policy.json +215 -0
- package/packs/ipums/source.md +169 -0
- package/packs/irs-soi/endpoints.json +114 -0
- package/packs/irs-soi/policy.json +107 -0
- package/packs/irs-soi/source.md +124 -0
- package/packs/medicaid/endpoints.json +412 -0
- package/packs/medicaid/policy.json +108 -0
- package/packs/medicaid/source.md +136 -0
- package/packs/naep/endpoints.json +217 -0
- package/packs/naep/policy.json +100 -0
- package/packs/naep/source.md +120 -0
- package/packs/nhtsa/endpoints.json +132 -0
- package/packs/nhtsa/policy.json +93 -0
- package/packs/nhtsa/source.md +109 -0
- package/packs/nih/endpoints.json +453 -0
- package/packs/nih/policy.json +86 -0
- package/packs/nih/source.md +108 -0
- package/packs/noaa/endpoints.json +432 -0
- package/packs/noaa/policy.json +95 -0
- package/packs/noaa/source.md +88 -0
- package/packs/nrel/endpoints.json +328 -0
- package/packs/nrel/policy.json +96 -0
- package/packs/nrel/source.md +91 -0
- package/packs/nws/endpoints.json +272 -0
- package/packs/nws/policy.json +82 -0
- package/packs/nws/source.md +81 -0
- package/packs/nyfed/endpoints.json +80 -0
- package/packs/nyfed/policy.json +92 -0
- package/packs/nyfed/source.md +89 -0
- package/packs/omb/endpoints.json +460 -0
- package/packs/omb/policy.json +106 -0
- package/packs/omb/source.md +130 -0
- package/packs/open-payments/endpoints.json +298 -0
- package/packs/open-payments/policy.json +101 -0
- package/packs/open-payments/source.md +99 -0
- package/packs/opm/assets/download_opm.ps1 +125 -0
- package/packs/opm/assets/download_opm.sh +85 -0
- package/packs/opm/docs/fields.md +184 -0
- package/packs/opm/docs/opm_api.md +71 -0
- package/packs/opm/docs/report_patterns.md +83 -0
- package/packs/opm/lib/data_dictionary.csv +73 -0
- package/packs/opm/policy.json +142 -0
- package/packs/opm/source.md +137 -0
- package/packs/pbgc/endpoints.json +483 -0
- package/packs/pbgc/policy.json +94 -0
- package/packs/pbgc/source.md +95 -0
- package/packs/philfed/endpoints.json +85 -0
- package/packs/philfed/policy.json +94 -0
- package/packs/philfed/source.md +125 -0
- package/packs/port.json +287 -0
- package/packs/regulations/endpoints.json +288 -0
- package/packs/regulations/policy.json +86 -0
- package/packs/regulations/source.md +84 -0
- package/packs/sec/endpoints.json +237 -0
- package/packs/sec/policy.json +86 -0
- package/packs/sec/source.md +101 -0
- package/packs/senate-lobbying/endpoints.json +554 -0
- package/packs/senate-lobbying/policy.json +99 -0
- package/packs/senate-lobbying/source.md +100 -0
- package/packs/snapqc/endpoints.json +1426 -0
- package/packs/snapqc/policy.json +92 -0
- package/packs/snapqc/source.md +96 -0
- package/packs/treasury/catalog.json +2267 -0
- package/packs/treasury/docs/api_guide.md +245 -0
- package/packs/treasury/docs/datasets.md +56 -0
- package/packs/treasury/docs/report_patterns.md +126 -0
- package/packs/treasury/policy.json +159 -0
- package/packs/treasury/source.md +170 -0
- package/packs/treasury-yields/endpoints.json +226 -0
- package/packs/treasury-yields/policy.json +86 -0
- package/packs/treasury-yields/source.md +80 -0
- package/packs/usaspending/endpoints.json +1316 -0
- package/packs/usaspending/policy.json +109 -0
- package/packs/usaspending/source.md +103 -0
- package/packs/usda-fna/endpoints.json +427 -0
- package/packs/usda-fna/policy.json +133 -0
- package/packs/usda-fna/source.md +217 -0
- package/packs/usda-fooddata/endpoints.json +181 -0
- package/packs/usda-fooddata/policy.json +94 -0
- package/packs/usda-fooddata/source.md +105 -0
- package/packs/usda-nass/endpoints.json +324 -0
- package/packs/usda-nass/policy.json +95 -0
- package/packs/usda-nass/source.md +85 -0
- package/packs/usda-outlook/endpoints.json +86 -0
- package/packs/usda-outlook/policy.json +109 -0
- package/packs/usda-outlook/source.md +144 -0
- package/packs/usgs/endpoints.json +313 -0
- package/packs/usgs/policy.json +95 -0
- package/packs/usgs/source.md +96 -0
- package/packs/usitc/endpoints.json +74 -0
- package/packs/usitc/policy.json +111 -0
- package/packs/usitc/source.md +90 -0
- package/packs/uspto/endpoints.json +141 -0
- package/packs/uspto/policy.json +95 -0
- package/packs/uspto/source.md +101 -0
- package/packs/va/endpoints.json +414 -0
- package/packs/va/policy.json +101 -0
- package/packs/va/source.md +129 -0
- package/packs/world-bank/endpoints.json +122 -0
- package/packs/world-bank/policy.json +101 -0
- package/packs/world-bank/source.md +93 -0
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Check that no API key or credential appears in any output file (a port of report/scan_secrets.py). Never
|
|
3
|
+
* reports a key: hits name the file and line only.
|
|
4
|
+
*
|
|
5
|
+
* Scans every file (large files in chunks, and every member of a .zip such as replication_package.zip,
|
|
6
|
+
* decompressed) for:
|
|
7
|
+
* - the literal value of every key core/keys.ts can find for any source pack, in any letter case
|
|
8
|
+
* - key-shaped assignments and URL parameters: <PACK>_API_KEY=..., "api_key": "...", ?api_key=<16+>,
|
|
9
|
+
* registrationkey=<hex>, UserID=<GUID> (BEA), BEA's echoed "ParameterName": "USERID", Authorization: Bearer ...
|
|
10
|
+
* (the placeholders {API_KEY}, [REDACTED] and __NAME__ are fine)
|
|
11
|
+
* - for sources whose API echoes keys in error text (policy auth.echoes_key: BLS, BEA), any 32-hex token, except
|
|
12
|
+
* inside data/<id>/ of a source that does not echo keys (its own identifiers) and inside references/ (saved
|
|
13
|
+
* pages: cache hashes, script ids); a PDF's /ID document ids are not keys either.
|
|
14
|
+
* A page the cite tool downloaded itself (no key sent, no credential in its URL, unchanged since: references/opened.json)
|
|
15
|
+
* is what every visitor gets, so a site key in its own script is not a secret: only the key values are looked for there.
|
|
16
|
+
*/
|
|
17
|
+
import crypto from "node:crypto";
|
|
18
|
+
import fs from "node:fs";
|
|
19
|
+
import path from "node:path";
|
|
20
|
+
import { unzipSync } from "fflate";
|
|
21
|
+
import { findKey, secretValues } from "../core/keys.js";
|
|
22
|
+
import { allPolicies } from "./policyset.js";
|
|
23
|
+
const CHUNK = 1 << 22;
|
|
24
|
+
// patterns run on latin1 text (one char per byte), as Python's bytes patterns do
|
|
25
|
+
const GUID = String.raw `[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}`;
|
|
26
|
+
const PLACE = String.raw `(?!\{API_KEY\}|\[REDACTED\]|__[A-Z_]+__)`;
|
|
27
|
+
const BASE_PATTERNS = [
|
|
28
|
+
new RegExp(String.raw `\b[A-Z][A-Z0-9_]*_(?:API_KEY|TOKEN|SECRET)['"]?\s*[=:]\s*['"]?` + PLACE + String.raw `[A-Za-z0-9-]{16,}`, "g"),
|
|
29
|
+
new RegExp(String.raw `(?:api[_-]?key|registrationkey|subscription-key|user_token|access_token)['"]?\s*[=:]\s*['"]` +
|
|
30
|
+
PLACE + String.raw `(?:[A-Za-z0-9-]{16,}|` + GUID + String.raw `)['"]`, "gi"),
|
|
31
|
+
new RegExp(String.raw `registrationkey['"]?\s*[=:]\s*['"]?` + PLACE + String.raw `[0-9a-f]{20,}`, "gi"),
|
|
32
|
+
new RegExp(String.raw `[?&](?:api_key|apikey|api-key|registrationkey|token|access_token|user_token|subscription-key)=` +
|
|
33
|
+
PLACE + String.raw `[A-Za-z0-9-]{16,}`, "gi"),
|
|
34
|
+
new RegExp(String.raw `[?&]userid=` + GUID, "gi"),
|
|
35
|
+
new RegExp(String.raw `"ParameterName"\s*:\s*"USERID"\s*,\s*"ParameterValue"\s*:\s*"` + GUID, "gi"),
|
|
36
|
+
new RegExp(String.raw `authorization['"]?\s*[:=]\s*['"]?(?:bearer\s+|token\s+|basic\s+)?` + PLACE + String.raw `[A-Za-z0-9._-]{30,}`, "gi"),
|
|
37
|
+
];
|
|
38
|
+
const HEX32 = /(?<![0-9a-f])[0-9a-f]{32}(?![0-9a-f])/gi;
|
|
39
|
+
const asciiLower = (s) => s.replace(/[A-Z]+/g, (x) => x.toLowerCase());
|
|
40
|
+
const latin1 = (s) => Buffer.from(s, "utf8").toString("latin1");
|
|
41
|
+
/** Every key the packs can find on this machine (looked up through core/keys.ts, never shown), as latin1 lower case. */
|
|
42
|
+
export function knownKeys(policies) {
|
|
43
|
+
const P = policies ?? allPolicies();
|
|
44
|
+
for (const p of Object.values(P)) {
|
|
45
|
+
const a = p.auth || {};
|
|
46
|
+
if (a.env)
|
|
47
|
+
findKey(a.env, a.home);
|
|
48
|
+
for (const v of Object.values(a.extra || {}))
|
|
49
|
+
if (typeof v === "string" && v === v.toUpperCase() && /[A-Z]/.test(v))
|
|
50
|
+
findKey(v, a.home);
|
|
51
|
+
}
|
|
52
|
+
return secretValues().filter((s) => s).map((s) => asciiLower(latin1(s)));
|
|
53
|
+
}
|
|
54
|
+
export function echoSources(policies) {
|
|
55
|
+
return Object.entries(policies).filter(([, p]) => p.auth?.echoes_key).map(([sid]) => sid);
|
|
56
|
+
}
|
|
57
|
+
/** Is the hex at pos the value of a URL query parameter whose name is not a credential (series=, id=)? */
|
|
58
|
+
function urlId(buf, pos) {
|
|
59
|
+
const before = buf.slice(Math.max(0, pos - 200), pos);
|
|
60
|
+
const m = /[?&]([A-Za-z_][\w.-]{0,30})=$/.exec(before);
|
|
61
|
+
return !!m && before.includes("http") && !/key|token|auth|secret|pass|user|reg|sig/i.test(m[1]);
|
|
62
|
+
}
|
|
63
|
+
function lineCount(s) {
|
|
64
|
+
let n = 0;
|
|
65
|
+
for (let i = s.indexOf("\n"); i >= 0; i = s.indexOf("\n", i + 1))
|
|
66
|
+
n++;
|
|
67
|
+
return n;
|
|
68
|
+
}
|
|
69
|
+
/** Scan a stream of chunks (latin1 text). */
|
|
70
|
+
function scanChunks(chunks, name, keys, hex32 = false, patterns = true) {
|
|
71
|
+
const hits = [];
|
|
72
|
+
const overlap = Math.max(...keys.map((k) => k.length), 200);
|
|
73
|
+
let prev = "", offsetLine = 1;
|
|
74
|
+
const pats = !patterns ? [] : hex32 ? [...BASE_PATTERNS, HEX32] : BASE_PATTERNS;
|
|
75
|
+
for (const chunk of chunks) {
|
|
76
|
+
if (!chunk)
|
|
77
|
+
break;
|
|
78
|
+
const buf = prev + chunk;
|
|
79
|
+
const low = keys.length ? asciiLower(buf) : "";
|
|
80
|
+
const prevLines = lineCount(prev);
|
|
81
|
+
const lineOf = (pos) => offsetLine + lineCount(buf.slice(0, pos)) - prevLines;
|
|
82
|
+
for (const k of keys) {
|
|
83
|
+
const i = low.indexOf(k);
|
|
84
|
+
if (i >= 0)
|
|
85
|
+
hits.push(`${name}: line ~${lineOf(i)}: contains an API key value`);
|
|
86
|
+
}
|
|
87
|
+
for (const p of pats) {
|
|
88
|
+
p.lastIndex = 0;
|
|
89
|
+
let m, found = null;
|
|
90
|
+
while ((m = p.exec(buf))) {
|
|
91
|
+
if (!(p === HEX32 && urlId(buf, m.index))) {
|
|
92
|
+
found = m;
|
|
93
|
+
break;
|
|
94
|
+
}
|
|
95
|
+
if (m[0].length === 0)
|
|
96
|
+
p.lastIndex++;
|
|
97
|
+
}
|
|
98
|
+
p.lastIndex = 0;
|
|
99
|
+
if (found) {
|
|
100
|
+
const what = p === HEX32 ? "a 32-hex token (a key this source echoes)" : "a hard-coded credential";
|
|
101
|
+
hits.push(`${name}: line ~${lineOf(found.index)}: looks like ${what}`);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
offsetLine += lineCount(chunk);
|
|
105
|
+
prev = buf.slice(-overlap);
|
|
106
|
+
}
|
|
107
|
+
return hits;
|
|
108
|
+
}
|
|
109
|
+
function* bufferChunks(b) {
|
|
110
|
+
for (let i = 0; i < b.length; i += CHUNK)
|
|
111
|
+
yield Buffer.from(b.buffer, b.byteOffset + i, Math.min(CHUNK, b.length - i)).toString("latin1");
|
|
112
|
+
}
|
|
113
|
+
function* fileChunks(p) {
|
|
114
|
+
const fd = fs.openSync(p, "r");
|
|
115
|
+
try {
|
|
116
|
+
const buf = Buffer.alloc(CHUNK);
|
|
117
|
+
for (;;) {
|
|
118
|
+
const n = fs.readSync(fd, buf, 0, CHUNK, null);
|
|
119
|
+
if (!n)
|
|
120
|
+
break;
|
|
121
|
+
yield buf.subarray(0, n).toString("latin1");
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
finally {
|
|
125
|
+
fs.closeSync(fd);
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
const parts = (rel) => rel.split(/[\\/]/).filter((x) => x && x !== ".");
|
|
129
|
+
/** Is rel (a path or zip member name) inside data/<id>/ of a source in quiet? */
|
|
130
|
+
export function otherSourceData(rel, quiet) {
|
|
131
|
+
const p = parts(rel);
|
|
132
|
+
return p.some((x, i) => i < p.length - 1 && x === "data" && i + 1 < p.length && quiet.has(p[i + 1]));
|
|
133
|
+
}
|
|
134
|
+
/** Is rel inside references/ (pages the cite tool saved: cache hashes and script ids, never an API reply)? */
|
|
135
|
+
export function referencePage(rel) {
|
|
136
|
+
const p = parts(rel);
|
|
137
|
+
return p.length > 0 && p[0] === "references";
|
|
138
|
+
}
|
|
139
|
+
const hexRule = (rel, quiet) => !otherSourceData(rel, quiet) && !referencePage(rel);
|
|
140
|
+
/** The files under references/ that the cite tool downloaded itself, from a URL with no credential in it, and that
|
|
141
|
+
* still have the hash it recorded (references/opened.json): public pages as served to anyone. */
|
|
142
|
+
export function publicSnapshots(root) {
|
|
143
|
+
const out = new Set();
|
|
144
|
+
let log;
|
|
145
|
+
try {
|
|
146
|
+
log = JSON.parse(fs.readFileSync(path.join(root, "references", "opened.json"), "utf8"));
|
|
147
|
+
}
|
|
148
|
+
catch {
|
|
149
|
+
return out;
|
|
150
|
+
}
|
|
151
|
+
for (const r of Object.values(log || {})) {
|
|
152
|
+
if (r?.via !== "download" || typeof r.file !== "string" || typeof r.url !== "string" || !referencePage(r.file))
|
|
153
|
+
continue;
|
|
154
|
+
if (scanText(r.url).length)
|
|
155
|
+
continue;
|
|
156
|
+
const f = path.resolve(root, r.file);
|
|
157
|
+
try {
|
|
158
|
+
if (crypto.createHash("sha256").update(fs.readFileSync(f)).digest("hex") === r.sha256)
|
|
159
|
+
out.add(f);
|
|
160
|
+
}
|
|
161
|
+
catch {
|
|
162
|
+
// gone or unreadable: scanned (or skipped) as any other file
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
return out;
|
|
166
|
+
}
|
|
167
|
+
/** zipfile.is_zipfile: an end-of-central-directory record near the end. */
|
|
168
|
+
function isZip(p) {
|
|
169
|
+
try {
|
|
170
|
+
const size = fs.statSync(p).size;
|
|
171
|
+
if (size < 22)
|
|
172
|
+
return false;
|
|
173
|
+
const n = Math.min(size, 65557);
|
|
174
|
+
const fd = fs.openSync(p, "r");
|
|
175
|
+
const b = Buffer.alloc(n);
|
|
176
|
+
fs.readSync(fd, b, 0, n, size - n);
|
|
177
|
+
fs.closeSync(fd);
|
|
178
|
+
return b.lastIndexOf(Buffer.from([0x50, 0x4b, 0x05, 0x06])) >= 0;
|
|
179
|
+
}
|
|
180
|
+
catch {
|
|
181
|
+
return false;
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
export function scanFile(p, keys = [], hex32 = false, quiet = new Set(), rel = "", patterns = true) {
|
|
185
|
+
const ks = (typeof keys === "string" ? [keys] : keys).filter((k) => k).map(asciiLower);
|
|
186
|
+
const head = Buffer.alloc(5);
|
|
187
|
+
const fd = fs.openSync(p, "r");
|
|
188
|
+
fs.readSync(fd, head, 0, 5, 0);
|
|
189
|
+
fs.closeSync(fd);
|
|
190
|
+
const pdf = head.toString("latin1") === "%PDF-"; // a PDF's trailer /ID holds two 32-hex document ids
|
|
191
|
+
let hits = scanChunks(fileChunks(p), p, ks, hex32 && !pdf && hexRule(rel || p, quiet), patterns);
|
|
192
|
+
if (isZip(p)) { // members are compressed: scan them decompressed too
|
|
193
|
+
try {
|
|
194
|
+
const z = unzipSync(fs.readFileSync(p));
|
|
195
|
+
for (const [name, data] of Object.entries(z)) {
|
|
196
|
+
if (name.endsWith("/"))
|
|
197
|
+
continue;
|
|
198
|
+
hits = hits.concat(scanChunks(bufferChunks(data), `${p}!${name}`, ks, hex32 && hexRule(name, quiet)));
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
catch {
|
|
202
|
+
// a damaged archive: its raw bytes were scanned above
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
return [...new Set(hits)].sort();
|
|
206
|
+
}
|
|
207
|
+
export function scanText(text, keys = [], hex32 = false, name = "text") {
|
|
208
|
+
const ks = keys.filter((k) => k).map(asciiLower);
|
|
209
|
+
return scanChunks(bufferChunks(Buffer.from(text, "utf8")), name, ks, hex32);
|
|
210
|
+
}
|
|
211
|
+
function walk(d) {
|
|
212
|
+
const out = [];
|
|
213
|
+
for (const e of fs.readdirSync(d, { withFileTypes: true })) {
|
|
214
|
+
const f = path.join(d, e.name);
|
|
215
|
+
if (e.isDirectory())
|
|
216
|
+
out.push(...walk(f));
|
|
217
|
+
else if (e.isFile())
|
|
218
|
+
out.push(f);
|
|
219
|
+
}
|
|
220
|
+
return out;
|
|
221
|
+
}
|
|
222
|
+
/** [hits, files scanned] for files and folders. */
|
|
223
|
+
export function scanTree(paths, keys, hex32 = false) {
|
|
224
|
+
// data/<id>/ of sources that never echo keys skip the 32-hex rule (their ids look like keys)
|
|
225
|
+
const quiet = hex32 ? new Set(Object.entries(allPolicies()).filter(([, p]) => !p.auth?.echoes_key).map(([s]) => s))
|
|
226
|
+
: new Set();
|
|
227
|
+
let found = [], n = 0;
|
|
228
|
+
for (const root of paths) {
|
|
229
|
+
const isFile = fs.existsSync(root) && fs.statSync(root).isFile();
|
|
230
|
+
const files = isFile ? [root] : fs.existsSync(root) ? walk(root) : [];
|
|
231
|
+
const pub = isFile ? new Set() : publicSnapshots(root);
|
|
232
|
+
for (const p of files) {
|
|
233
|
+
n++;
|
|
234
|
+
try {
|
|
235
|
+
const rel = isFile ? p : path.relative(root, p);
|
|
236
|
+
found = found.concat(scanFile(p, keys, hex32, quiet, rel, !pub.has(path.resolve(p))));
|
|
237
|
+
}
|
|
238
|
+
catch {
|
|
239
|
+
// unreadable: skipped (as the Python scan does, with a note on stderr)
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
return [found, n];
|
|
244
|
+
}
|
|
245
|
+
/** Hits with the folder's own path taken off (workspace-relative names in tool output). */
|
|
246
|
+
export function relHits(hits, base) {
|
|
247
|
+
const pre = path.resolve(base) + path.sep;
|
|
248
|
+
return hits.map((h) => (h.startsWith(pre) ? h.slice(pre.length).replaceAll("\\", "/") : h));
|
|
249
|
+
}
|
|
250
|
+
/** The scan_secrets.py command on a folder: sources from data/<id>/ unless given. */
|
|
251
|
+
export function scanWorkspace(dir, sources) {
|
|
252
|
+
const policies = allPolicies();
|
|
253
|
+
let ids = sources;
|
|
254
|
+
if (ids === undefined) {
|
|
255
|
+
const d = path.join(dir, "data");
|
|
256
|
+
ids = fs.existsSync(d) ? fs.readdirSync(d).sort() : [];
|
|
257
|
+
}
|
|
258
|
+
const used = Object.fromEntries(ids.filter((s) => s in policies).map((s) => [s, policies[s]]));
|
|
259
|
+
const [raw, n] = scanTree([dir], knownKeys(policies), echoSources(used).length > 0);
|
|
260
|
+
const hits = relHits(raw, dir);
|
|
261
|
+
return hits.length
|
|
262
|
+
? { ok: false, files: n, hits, message: "SECRET FOUND - remove before sharing:\n" + hits.join("\n") }
|
|
263
|
+
: { ok: true, files: n, hits, message: `OK: scanned ${n} files; no API key or credential found.` };
|
|
264
|
+
}
|
|
265
|
+
//# sourceMappingURL=scan_secrets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scan_secrets.js","sourceRoot":"","sources":["../../src/report/scan_secrets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;AACtB,iFAAiF;AACjF,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAA,6EAA6E,CAAC;AACrG,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA,0CAA0C,CAAC;AACnE,MAAM,aAAa,GAAG;IACpB,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,gEAAgE,GAAG,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA,mBAAmB,EAAE,GAAG,CAAC;IACnI,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,6FAA6F;QAChH,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA,uBAAuB,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAA,OAAO,EAAE,IAAI,CAAC;IAC7E,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,qCAAqC,GAAG,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA,eAAe,EAAE,IAAI,CAAC;IACrG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,gGAAgG;QACnH,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA,mBAAmB,EAAE,IAAI,CAAC;IAC9C,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,aAAa,GAAG,IAAI,EAAE,IAAI,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,+DAA+D,GAAG,IAAI,EAAE,IAAI,CAAC;IAClG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,mEAAmE,GAAG,KAAK,GAAG,MAAM,CAAC,GAAG,CAAA,qBAAqB,EAAE,IAAI,CAAC;CAC1I,CAAC;AACF,MAAM,KAAK,GAAG,yCAAyC,CAAC;AAExD,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/E,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAExE,wHAAwH;AACxH,MAAM,UAAU,SAAS,CAAC,QAAiC;IACzD,MAAM,CAAC,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;IACpC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,MAAM,CAAC,GAAQ,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,CAAC,GAAG;YAAE,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAClC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAAE,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC1I,CAAC;IACD,OAAO,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAAgC;IAC1D,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,IAAY,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;AACrG,CAAC;AAED,0GAA0G;AAC1G,SAAS,KAAK,CAAC,GAAW,EAAE,GAAW;IACrC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,+BAA+B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,0CAA0C,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,SAAS,SAAS,CAAC,CAAS;IAC1B,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;QAAE,CAAC,EAAE,CAAC;IACtE,OAAO,CAAC,CAAC;AACX,CAAC;AAED,6CAA6C;AAC7C,SAAS,UAAU,CAAC,MAAwB,EAAE,IAAY,EAAE,IAAc,EAAE,KAAK,GAAG,KAAK,EAAE,QAAQ,GAAG,IAAI;IACxG,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5D,IAAI,IAAI,GAAG,EAAE,EAAE,UAAU,GAAG,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IAChF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,KAAK;YAAE,MAAM;QAClB,MAAM,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;QACtF,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC;gBAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC;QAClF,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC;YAChB,IAAI,CAAyB,EAAE,KAAK,GAA2B,IAAI,CAAC;YACpE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACzB,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;oBAC1C,KAAK,GAAG,CAAC,CAAC;oBACV,MAAM;gBACR,CAAC;gBACD,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC;oBAAE,CAAC,CAAC,SAAS,EAAE,CAAC;YACvC,CAAC;YACD,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC;YAChB,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,IAAI,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,2CAA2C,CAAC,CAAC,CAAC,yBAAyB,CAAC;gBACnG,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QACD,UAAU,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAa;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,KAAK;QAAE,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC5I,CAAC;AAED,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAS;IAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAChC,SAAS,CAAC;YACR,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,CAAC,CAAC;gBAAE,MAAM;YACd,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;YAAS,CAAC;QACT,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;AAEhF,iFAAiF;AACjF,MAAM,UAAU,eAAe,CAAC,GAAW,EAAE,KAAkB;IAC7D,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IACrB,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;AAED,8GAA8G;AAC9G,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IACrB,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC;AAC/C,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,KAAkB,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;AAEzG;kGACkG;AAClG,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,IAAI,GAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1F,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC;IACb,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,EAAE,GAAG,KAAK,UAAU,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;YAAE,SAAS;QACzH,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM;YAAE,SAAS;QACrC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC;YACH,IAAI,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM;gBAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACpG,CAAC;QAAC,MAAM,CAAC;YACP,6DAA6D;QAC/D,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,2EAA2E;AAC3E,SAAS,KAAK,CAAC,CAAS;IACtB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACjC,IAAI,IAAI,GAAG,EAAE;YAAE,OAAO,KAAK,CAAC;QAC5B,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAChC,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1B,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QACnC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjB,OAAO,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACnE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAS,EAAE,OAA0B,EAAE,EAAE,KAAK,GAAG,KAAK,EAAE,QAAQ,IAAI,GAAG,EAAU,EAAE,GAAG,GAAG,EAAE,EAClH,QAAQ,GAAG,IAAI;IACf,MAAM,EAAE,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACvF,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/B,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACjB,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,CAAS,oDAAoD;IAC7G,IAAI,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;IACjG,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAA0C,qDAAqD;QAC5G,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAAE,SAAS;gBACjC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,EAAE,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YACxG,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,sDAAsD;QACxD,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,OAAiB,EAAE,EAAE,KAAK,GAAG,KAAK,EAAE,IAAI,GAAG,MAAM;IACtF,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACjD,OAAO,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,IAAI,CAAC,CAAS;IACrB,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3D,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,CAAC,WAAW,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;aACrC,IAAI,CAAC,CAAC,MAAM,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,QAAQ,CAAC,KAAe,EAAE,IAAc,EAAE,KAAK,GAAG,KAAK;IACrE,6FAA6F;IAC7F,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,CAAC,CAAC,IAAY,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1H,CAAC,CAAC,IAAI,GAAG,EAAU,CAAC;IACtB,IAAI,KAAK,GAAa,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACjE,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,EAAU,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,CAAC,EAAE,CAAC;YACJ,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBAChD,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxF,CAAC;YAAC,MAAM,CAAC;gBACP,uEAAuE;YACzE,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;AACpB,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,OAAO,CAAC,IAAc,EAAE,IAAY;IAClD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,OAAkB;IAC3D,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,IAAI,GAAG,GAAG,OAAO,CAAC;IAClB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACjC,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACpF,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC,MAAM;QAChB,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,yCAAyC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACrG,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,CAAC,yCAAyC,EAAE,CAAC;AACvG,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export declare function stripMd(s: string): string;
|
|
2
|
+
/** [where, paragraph] pairs of prose that the style rules apply to. */
|
|
3
|
+
export declare function paragraphs(R: any): [string, string][];
|
|
4
|
+
export declare function sentences(par: string): string[];
|
|
5
|
+
export declare function words(sent: string): string[];
|
|
6
|
+
export declare function styleIssues(sent: string): string[];
|
|
7
|
+
export declare const TARGET = 90;
|
|
8
|
+
/** [score %, sentences, compliant, issue rows] for the report's prose. */
|
|
9
|
+
export declare function score(R: any): [number, number, number, {
|
|
10
|
+
where: string;
|
|
11
|
+
sentence: string;
|
|
12
|
+
issues: string[];
|
|
13
|
+
}[]];
|
|
14
|
+
/** The style_check.py result for a report.json object. */
|
|
15
|
+
export declare function styleCheck(R: any, min?: number): {
|
|
16
|
+
mode: any;
|
|
17
|
+
standard: string;
|
|
18
|
+
sentences: number;
|
|
19
|
+
compliant: number;
|
|
20
|
+
score: number;
|
|
21
|
+
target: number;
|
|
22
|
+
pass: boolean;
|
|
23
|
+
summary: string;
|
|
24
|
+
issues: {
|
|
25
|
+
sentence: string;
|
|
26
|
+
where: string;
|
|
27
|
+
issues: string[];
|
|
28
|
+
}[];
|
|
29
|
+
};
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Check the prose in report.json against the style guide (a port of report/style_check.py). Results are
|
|
3
|
+
* returned only; nothing is written into the report. One rule set for every source pack: the Roman-numeral
|
|
4
|
+
* exceptions for "I" (Title I, level I, Schedule I), U.S.C./C.F.R. citations, and dates, quarters, fiscal years,
|
|
5
|
+
* titles, levels and codes before a small numeral are allowed. Score = percent of sentences with no issue.
|
|
6
|
+
*/
|
|
7
|
+
import { rx, search, finditer, split, splitlines, pyRound, strip } from "./py.js";
|
|
8
|
+
const ABBREV = ["U.S.C.", "C.F.R.", "U.S.", "e.g.", "i.e.", "vs.", "etc.", "No.", "Dr.", "Mr.", "Ms.", "Jan.", "Feb.", "Aug.",
|
|
9
|
+
"Sept.", "Oct.", "Nov.", "Dec.", "a.m.", "p.m.", "approx.", "Inc.", "Jr.", "St."];
|
|
10
|
+
export function stripMd(s) {
|
|
11
|
+
s = s.replace(/\{\{[^}]*\}\}/g, "X"); // {{fact|fmt}} placeholders stand for one number
|
|
12
|
+
s = s.replace(/`[^`]*`/g, "X"); // code spans count as one technical name
|
|
13
|
+
s = s.replace(/\[\^\d+\]/g, "");
|
|
14
|
+
s = s.replace(/\[([^\]]+)\]\([^)]+\)/g, (_m, a) => a);
|
|
15
|
+
return s.replaceAll("**", "").replaceAll("*", "");
|
|
16
|
+
}
|
|
17
|
+
/** [where, paragraph] pairs of prose that the style rules apply to. */
|
|
18
|
+
export function paragraphs(R) {
|
|
19
|
+
const out = [];
|
|
20
|
+
const add = (where, text) => {
|
|
21
|
+
if (Array.isArray(text)) {
|
|
22
|
+
for (const t of text)
|
|
23
|
+
add(where, t);
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
const s = text === null || text === undefined || text === "" ? "" : typeof text === "string" ? text : String(text);
|
|
27
|
+
for (const block of split(/\n\s*\n/, strip(s))) {
|
|
28
|
+
const lines = splitlines(block).map((l) => strip(l)).filter((l) => l);
|
|
29
|
+
if (lines.length && lines.every((l) => l.startsWith("- ") || l.startsWith("* "))) {
|
|
30
|
+
for (const l of lines)
|
|
31
|
+
out.push([where, stripMd(l.slice(2))]);
|
|
32
|
+
}
|
|
33
|
+
else if (lines.length)
|
|
34
|
+
out.push([where, stripMd(lines.join(" "))]);
|
|
35
|
+
}
|
|
36
|
+
};
|
|
37
|
+
const leadText = (s) => (s && typeof s === "object" && !Array.isArray(s) ? (s.lead ?? "") + " " + (s.text ?? "") : s);
|
|
38
|
+
add("subtitle", R.subtitle);
|
|
39
|
+
for (const s of R.summary || [])
|
|
40
|
+
add("summary", leadText(s));
|
|
41
|
+
const g = R.at_a_glance || {};
|
|
42
|
+
add("at a glance", g.text);
|
|
43
|
+
for (const s of g.findings || [])
|
|
44
|
+
add("at a glance", leadText(s));
|
|
45
|
+
add("notes page", R.notes_page);
|
|
46
|
+
const intro = R.introduction || {};
|
|
47
|
+
add("introduction", intro.text);
|
|
48
|
+
for (const x of intro.subsections || [])
|
|
49
|
+
add(`introduction '${x.heading ?? ""}'`, x.body);
|
|
50
|
+
add("introduction footnotes", intro.footnotes);
|
|
51
|
+
for (const s of R.sections || []) {
|
|
52
|
+
add(`section '${s.heading ?? ""}'`, s.body);
|
|
53
|
+
add(`section '${s.heading ?? ""}' footnotes`, s.footnotes);
|
|
54
|
+
}
|
|
55
|
+
(R.exhibits || []).forEach((e, i) => {
|
|
56
|
+
add(`exhibit ${i + 1} text`, e.text);
|
|
57
|
+
add(`exhibit ${i + 1} notes`, e.notes);
|
|
58
|
+
});
|
|
59
|
+
add("methods", R.methods);
|
|
60
|
+
for (const a of R.appendixes || [])
|
|
61
|
+
add(`appendix '${a.title ?? ""}'`, a.body);
|
|
62
|
+
add("footnotes", R.footnotes);
|
|
63
|
+
add("about", R.about);
|
|
64
|
+
return out.filter(([, p]) => strip(p));
|
|
65
|
+
}
|
|
66
|
+
export function sentences(par) {
|
|
67
|
+
let t = par;
|
|
68
|
+
ABBREV.forEach((a, i) => (t = t.replaceAll(a, `\x00${i}\x00`)));
|
|
69
|
+
const res = [];
|
|
70
|
+
for (let p of split(/(?<=[.!?;:])\s+(?=[A-Z0-9"“($])/, t)) {
|
|
71
|
+
ABBREV.forEach((a, i) => (p = p.replaceAll(`\x00${i}\x00`, a)));
|
|
72
|
+
if (strip(p))
|
|
73
|
+
res.push(strip(p));
|
|
74
|
+
}
|
|
75
|
+
return res;
|
|
76
|
+
}
|
|
77
|
+
export function words(sent) {
|
|
78
|
+
return (sent.match(/[A-Za-z0-9$%][\w$%’'.,/-]*/g) || []).filter((w) => /\w/.test(w));
|
|
79
|
+
}
|
|
80
|
+
const STYLE_RULES = [
|
|
81
|
+
[String.raw `\d\s?%`, "use 'percent' in text, not '%'"],
|
|
82
|
+
[String.raw `\bcompared to\b`, "'compared with' for differences"],
|
|
83
|
+
[String.raw `\butiliz`, "'use', not 'utilize'"],
|
|
84
|
+
[String.raw `\bimpact(?:s|ed|ing)?\b(?=\s+(?:the|their|its|on)\b)`, "avoid 'impact' as a verb; use 'affect'"],
|
|
85
|
+
[String.raw `\bdata (?:is|was|shows|suggests|indicates)\b`, "'data' takes a plural verb"],
|
|
86
|
+
[String.raw `^\d`, "do not start a sentence with a numeral; spell it out or recast"],
|
|
87
|
+
[String.raw `\b(?:e\.g\.|i\.e\.|etc\.)`, "write 'for example' / 'that is'; avoid 'etc.' in text"],
|
|
88
|
+
[String.raw `\bin order to\b`, "'to', not 'in order to'"],
|
|
89
|
+
// "I" as a pronoun, not the Roman numeral ("Executive Schedule level I", "Title I", "Phase I")
|
|
90
|
+
[String.raw `\b(?:[Ww]e|[Oo]urs?|us|[Yy]ou|[Yy]ours?)\b|(?<!level )(?<!Level )(?<!Title )(?<!Part )(?<!Phase )(?<!Tier )` +
|
|
91
|
+
String.raw `(?<!schedule )(?<!Schedule )(?<!Appendix )(?<!Volume )(?<!War )(?<!Class )(?<!Category )\bI\b(?![.-]\w)`,
|
|
92
|
+
"no first or second person; name the organization or write 'this analysis'"],
|
|
93
|
+
[String.raw `!`, "no exclamation marks"],
|
|
94
|
+
[String.raw `(?<![\d./-])\b\d{1,4}\s?-\s?\d{1,4}\b(?![-./\d])`, "ranges: 'from X to Y' or an en dash (2013–2023), never a hyphen"],
|
|
95
|
+
[String.raw `\baged\s+\d`, "'ages 25 to 54', not 'aged'"],
|
|
96
|
+
[String.raw `\bpersons\b`, "'people', not 'persons'"],
|
|
97
|
+
[String.raw `\bgender\b`, "'sex' for survey classifications"],
|
|
98
|
+
[String.raw `\b(?:fell|rose|increased|decreased|declined|grew|changed)\s+due to\b`, "'because of' after a verb; 'due to' only after a noun"],
|
|
99
|
+
[String.raw `\bper cent\b`, "'percent'"],
|
|
100
|
+
[String.raw `\bimpact(?:s|ed)?\s+(?:the|their|its|on)\b`, "never 'impact' as a verb; use 'affect'"],
|
|
101
|
+
[String.raw `(?i)\b(?:he or she|his or her|him or her)\b`, "avoid 'he or she'; make it plural, rewrite, or use singular 'they'"],
|
|
102
|
+
[String.raw `(?i)\btimes (?:less|lower|smaller|fewer|more|higher|larger|greater)\b`, "not 'times less/more'; write 'one-third as large' or 'six times as much as'"],
|
|
103
|
+
[String.raw `(?i)\b(?:appears?|appeared|seems?|seemed) to\b`, "avoid vague 'appear to' / 'seem to'; state what the data show"],
|
|
104
|
+
[String.raw `(?i)\baround\s+\$?\d`, "'about' or 'roughly', not 'around'"],
|
|
105
|
+
[String.raw `(?i)\bpercentage points? of\b`, "never 'percentage points of'; write 'by 2 percentage points' or 'by 2 percent of GDP'"],
|
|
106
|
+
[String.raw `(?i)\b(?:fairly|quite|somewhat)\b|\brather\b(?!\s+than)`, "cut vague modifiers ('fairly', 'quite', 'rather', 'somewhat')"],
|
|
107
|
+
[String.raw `(?i)\b(?:prior|subsequent) to\b`, "'before' / 'after'"],
|
|
108
|
+
[String.raw `(?i)\b(?:regarding|concerning|upon)\b`, "'about' or 'on' (plain English)"],
|
|
109
|
+
[String.raw `(?i)\bthe elderly\b|\belderly (?:people|adults|population)\b`, "give the age range ('people age 65 or older'), not 'elderly'"],
|
|
110
|
+
[String.raw `\b(?:Blacks|Whites)\b`, "'Black' and 'White' are adjectives ('Black workers'), never nouns for people"],
|
|
111
|
+
[String.raw `\b(?:black|white) (?:people|workers|men|women|adults|children|residents|households|families|respondents)\b`, "capitalize 'Black' and 'White' as racial designations"],
|
|
112
|
+
[String.raw `\bAmericans\b`, "'U.S. residents' (or 'U.S. citizens'), not 'Americans'"],
|
|
113
|
+
[String.raw `\breform\b`, "'reform' is not neutral; use 'change' or 'restructure'"],
|
|
114
|
+
[String.raw `(?i)\b(?:full|part) time\b`, "'full-time' / 'part-time' are always hyphenated"],
|
|
115
|
+
[String.raw `(?i)\band/or\b`, "'X, Y, or both', not 'and/or'"],
|
|
116
|
+
[String.raw `(?i)\bdata set\b`, "'dataset' (one word)"],
|
|
117
|
+
[String.raw `(?<=\s)Internet\b`, "'internet' is lowercase"],
|
|
118
|
+
[String.raw `\bthe Fed\b`, "'the Federal Reserve', not 'the Fed'"],
|
|
119
|
+
[String.raw `(?i)\banalytic\b`, "'analytical', not 'analytic'"],
|
|
120
|
+
[String.raw `(?i)\bmethodology\b`, "'method' or 'approach', not 'methodology'"],
|
|
121
|
+
[String.raw `(?i)\blion's share\b`, "avoid 'lion's share'; give the share"],
|
|
122
|
+
[String.raw `(?i)\bbetween (?:19|20)\d\d and (?:19|20)\d\d\b`, "date ranges: 'from 2013 to 2023', not 'between ... and'"],
|
|
123
|
+
[String.raw `(?i)\bfrom (?:19|20)\d\d\s?[–-]\s?(?:19|20)\d\d\b`, "do not mix 'from' with a dash; 'from 2013 to 2023'"],
|
|
124
|
+
].map(([p, m]) => [rx(p), m]);
|
|
125
|
+
const SMALL_NUM = rx(String.raw `(?<![\w$.,–-])([1-9])(?![\w.,%–-])` +
|
|
126
|
+
String.raw `(?!\s*(?:percent|percentage|million|billion|trillion|to\s+1|U\.S\.C\.|C\.F\.R\.))`);
|
|
127
|
+
const REF_BEFORE = rx(String.raw `(?:(?:Exhibits?|Figures?|Tables?)(?:\s+\d+\s*(?:,?\s*(?:and|to)|[–,-]))*|Appendix|Box|Chapter|` +
|
|
128
|
+
String.raw `ages?|age|grade|Grade|Section|step|[Nn]o\.|group|code|level|[Tt]itle|[Pp]art|Q|FY|` +
|
|
129
|
+
String.raw `(?:January|February|March|April|May|June|July|August|September|October|November|December|` +
|
|
130
|
+
String.raw `Jan|Feb|Mar|Apr|Jun|Jul|Aug|Sept?|Oct|Nov|Dec)\.?)\s*$`);
|
|
131
|
+
export function styleIssues(sent) {
|
|
132
|
+
const out = [];
|
|
133
|
+
for (const [pat, msg] of STYLE_RULES)
|
|
134
|
+
if (msg && search(pat, sent))
|
|
135
|
+
out.push(msg);
|
|
136
|
+
for (const m of finditer(SMALL_NUM, sent)) {
|
|
137
|
+
if (!search(REF_BEFORE, sent.slice(0, m.index))) {
|
|
138
|
+
out.push(`spell out '${m[1]}' (zero through nine in words, unless percent, money, or a reference)`);
|
|
139
|
+
break;
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
const n = words(sent).length;
|
|
143
|
+
if (n > 40)
|
|
144
|
+
out.push(`${n} words: consider splitting (prefer plain, direct sentences)`);
|
|
145
|
+
return out;
|
|
146
|
+
}
|
|
147
|
+
export const TARGET = 90;
|
|
148
|
+
/** [score %, sentences, compliant, issue rows] for the report's prose. */
|
|
149
|
+
export function score(R) {
|
|
150
|
+
const rows = [];
|
|
151
|
+
let total = 0, clean = 0;
|
|
152
|
+
for (const [where, par] of paragraphs(R)) {
|
|
153
|
+
for (const s of sentences(par)) {
|
|
154
|
+
const iss = styleIssues(s);
|
|
155
|
+
total++;
|
|
156
|
+
if (!iss.length)
|
|
157
|
+
clean++;
|
|
158
|
+
else
|
|
159
|
+
rows.push({ where, sentence: s, issues: iss });
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
return [total ? pyRound((100 * clean) / total, 1) : 100.0, total, clean, rows];
|
|
163
|
+
}
|
|
164
|
+
/** The style_check.py result for a report.json object. */
|
|
165
|
+
export function styleCheck(R, min) {
|
|
166
|
+
const target = min ?? TARGET;
|
|
167
|
+
const [sc, total, clean, rows] = score(R);
|
|
168
|
+
const pass = sc >= target;
|
|
169
|
+
return { mode: R.mode || "report", standard: "Style guide", sentences: total, compliant: clean, score: sc, target, pass,
|
|
170
|
+
summary: `Style guide: ${clean}/${total} sentences compliant = ${sc}% (target ${target}%) -> ${pass ? "PASS" : "REVISE"}`,
|
|
171
|
+
issues: rows.map((r) => ({ ...r, sentence: r.sentence.slice(0, 160) })) };
|
|
172
|
+
}
|
|
173
|
+
//# sourceMappingURL=style_check.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"style_check.js","sourceRoot":"","sources":["../../src/report/style_check.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAElF,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAC3H,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAEpF,MAAM,UAAU,OAAO,CAAC,CAAS;IAC/B,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,CAAiB,iDAAiD;IACvG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAuB,yCAAyC;IAC/F,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACtD,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,UAAU,CAAC,CAAM;IAC/B,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,IAAa,EAAQ,EAAE;QACjD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,KAAK,MAAM,CAAC,IAAI,IAAI;gBAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACpC,OAAO;QACT,CAAC;QACD,MAAM,CAAC,GAAG,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnH,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;YACtE,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBACjF,KAAK,MAAM,CAAC,IAAI,KAAK;oBAAE,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChE,CAAC;iBAAM,IAAI,KAAK,CAAC,MAAM;gBAAE,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3H,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE;QAAE,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC;IAC9B,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3B,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,EAAE;QAAE,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC;IACnC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAChC,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,WAAW,IAAI,EAAE;QAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC,OAAO,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC1F,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/C,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QACjC,GAAG,CAAC,YAAY,CAAC,CAAC,OAAO,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5C,GAAG,CAAC,YAAY,CAAC,CAAC,OAAO,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IACD,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAM,EAAE,CAAS,EAAE,EAAE;QAC/C,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACrC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IAC1B,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,EAAE;QAAE,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC/E,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IAC9B,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACtB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,IAAI,CAAC,GAAG,GAAG,CAAC;IACZ,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,IAAI,CAAC,IAAI,KAAK,CAAC,iCAAiC,EAAE,CAAC,CAAC,EAAE,CAAC;QAC1D,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,CAAC,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,IAAY;IAChC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACvF,CAAC;AAED,MAAM,WAAW,GAAwB;IACvC,CAAC,MAAM,CAAC,GAAG,CAAA,QAAQ,EAAE,gCAAgC,CAAC;IACtD,CAAC,MAAM,CAAC,GAAG,CAAA,iBAAiB,EAAE,iCAAiC,CAAC;IAChE,CAAC,MAAM,CAAC,GAAG,CAAA,UAAU,EAAE,sBAAsB,CAAC;IAC9C,CAAC,MAAM,CAAC,GAAG,CAAA,sDAAsD,EAAE,wCAAwC,CAAC;IAC5G,CAAC,MAAM,CAAC,GAAG,CAAA,8CAA8C,EAAE,4BAA4B,CAAC;IACxF,CAAC,MAAM,CAAC,GAAG,CAAA,KAAK,EAAE,gEAAgE,CAAC;IACnF,CAAC,MAAM,CAAC,GAAG,CAAA,2BAA2B,EAAE,uDAAuD,CAAC;IAChG,CAAC,MAAM,CAAC,GAAG,CAAA,iBAAiB,EAAE,yBAAyB,CAAC;IACxD,+FAA+F;IAC/F,CAAC,MAAM,CAAC,GAAG,CAAA,6GAA6G;YACtH,MAAM,CAAC,GAAG,CAAA,yGAAyG;QACrH,2EAA2E,CAAC;IAC5E,CAAC,MAAM,CAAC,GAAG,CAAA,GAAG,EAAE,sBAAsB,CAAC;IACvC,CAAC,MAAM,CAAC,GAAG,CAAA,kDAAkD,EAAE,iEAAiE,CAAC;IACjI,CAAC,MAAM,CAAC,GAAG,CAAA,aAAa,EAAE,6BAA6B,CAAC;IACxD,CAAC,MAAM,CAAC,GAAG,CAAA,aAAa,EAAE,yBAAyB,CAAC;IACpD,CAAC,MAAM,CAAC,GAAG,CAAA,YAAY,EAAE,kCAAkC,CAAC;IAC5D,CAAC,MAAM,CAAC,GAAG,CAAA,sEAAsE,EAAE,uDAAuD,CAAC;IAC3I,CAAC,MAAM,CAAC,GAAG,CAAA,cAAc,EAAE,WAAW,CAAC;IACvC,CAAC,MAAM,CAAC,GAAG,CAAA,4CAA4C,EAAE,wCAAwC,CAAC;IAClG,CAAC,MAAM,CAAC,GAAG,CAAA,6CAA6C,EAAE,oEAAoE,CAAC;IAC/H,CAAC,MAAM,CAAC,GAAG,CAAA,uEAAuE,EAAE,6EAA6E,CAAC;IAClK,CAAC,MAAM,CAAC,GAAG,CAAA,gDAAgD,EAAE,+DAA+D,CAAC;IAC7H,CAAC,MAAM,CAAC,GAAG,CAAA,sBAAsB,EAAE,oCAAoC,CAAC;IACxE,CAAC,MAAM,CAAC,GAAG,CAAA,+BAA+B,EAAE,uFAAuF,CAAC;IACpI,CAAC,MAAM,CAAC,GAAG,CAAA,yDAAyD,EAAE,+DAA+D,CAAC;IACtI,CAAC,MAAM,CAAC,GAAG,CAAA,iCAAiC,EAAE,oBAAoB,CAAC;IACnE,CAAC,MAAM,CAAC,GAAG,CAAA,uCAAuC,EAAE,iCAAiC,CAAC;IACtF,CAAC,MAAM,CAAC,GAAG,CAAA,8DAA8D,EAAE,8DAA8D,CAAC;IAC1I,CAAC,MAAM,CAAC,GAAG,CAAA,uBAAuB,EAAE,8EAA8E,CAAC;IACnH,CAAC,MAAM,CAAC,GAAG,CAAA,4GAA4G,EAAE,uDAAuD,CAAC;IACjL,CAAC,MAAM,CAAC,GAAG,CAAA,eAAe,EAAE,wDAAwD,CAAC;IACrF,CAAC,MAAM,CAAC,GAAG,CAAA,YAAY,EAAE,wDAAwD,CAAC;IAClF,CAAC,MAAM,CAAC,GAAG,CAAA,4BAA4B,EAAE,iDAAiD,CAAC;IAC3F,CAAC,MAAM,CAAC,GAAG,CAAA,gBAAgB,EAAE,+BAA+B,CAAC;IAC7D,CAAC,MAAM,CAAC,GAAG,CAAA,kBAAkB,EAAE,sBAAsB,CAAC;IACtD,CAAC,MAAM,CAAC,GAAG,CAAA,mBAAmB,EAAE,yBAAyB,CAAC;IAC1D,CAAC,MAAM,CAAC,GAAG,CAAA,aAAa,EAAE,sCAAsC,CAAC;IACjE,CAAC,MAAM,CAAC,GAAG,CAAA,kBAAkB,EAAE,8BAA8B,CAAC;IAC9D,CAAC,MAAM,CAAC,GAAG,CAAA,qBAAqB,EAAE,2CAA2C,CAAC;IAC9E,CAAC,MAAM,CAAC,GAAG,CAAA,sBAAsB,EAAE,sCAAsC,CAAC;IAC1E,CAAC,MAAM,CAAC,GAAG,CAAA,iDAAiD,EAAE,yDAAyD,CAAC;IACxH,CAAC,MAAM,CAAC,GAAG,CAAA,mDAAmD,EAAE,oDAAoD,CAAC;CAC/F,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAErD,MAAM,SAAS,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAA,oCAAoC;IACjE,MAAM,CAAC,GAAG,CAAA,mFAAmF,CAAC,CAAC;AACjG,MAAM,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAA,gGAAgG;IAC9H,MAAM,CAAC,GAAG,CAAA,oFAAoF;IAC9F,MAAM,CAAC,GAAG,CAAA,2FAA2F;IACrG,MAAM,CAAC,GAAG,CAAA,wDAAwD,CAAC,CAAC;AAEtE,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,WAAW;QAAE,IAAI,GAAG,IAAI,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClF,KAAK,MAAM,CAAC,IAAI,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAChD,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,uEAAuE,CAAC,CAAC;YACpG,MAAM;QACR,CAAC;IACH,CAAC;IACD,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;IACxF,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,EAAE,CAAC;AAEzB,0EAA0E;AAC1E,MAAM,UAAU,KAAK,CAAC,CAAM;IAC1B,MAAM,IAAI,GAA4D,EAAE,CAAC;IACzE,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC;IACzB,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAC3B,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,GAAG,CAAC,MAAM;gBAAE,KAAK,EAAE,CAAC;;gBACpB,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AACjF,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,UAAU,CAAC,CAAM,EAAE,GAAY;IAC7C,MAAM,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC;IAC7B,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,EAAE,IAAI,MAAM,CAAC;IAC1B,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI;QACrH,OAAO,EAAE,gBAAgB,KAAK,IAAI,KAAK,0BAA0B,EAAE,aAAa,MAAM,SAAS,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;QACzH,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;AAC9E,CAAC"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import type { Session } from "../session.js";
|
|
2
|
+
import type { ToolDef } from "../toolkit.js";
|
|
3
|
+
export declare function auditAnswerTool(s: Session, a: {
|
|
4
|
+
answer: string;
|
|
5
|
+
online?: boolean;
|
|
6
|
+
rerun?: boolean;
|
|
7
|
+
}): Promise<{
|
|
8
|
+
status: string;
|
|
9
|
+
summary: string;
|
|
10
|
+
passed: boolean;
|
|
11
|
+
checks: {
|
|
12
|
+
check: string;
|
|
13
|
+
status: string;
|
|
14
|
+
message: string;
|
|
15
|
+
}[];
|
|
16
|
+
report: string;
|
|
17
|
+
files: string[];
|
|
18
|
+
notes: string[];
|
|
19
|
+
next: string;
|
|
20
|
+
}>;
|
|
21
|
+
export declare function buildReportTool(s: Session, a: {
|
|
22
|
+
report: any;
|
|
23
|
+
}): Promise<{
|
|
24
|
+
status: string;
|
|
25
|
+
summary: {
|
|
26
|
+
mode: string;
|
|
27
|
+
sources: string[];
|
|
28
|
+
exhibits: number;
|
|
29
|
+
facts_cited: number;
|
|
30
|
+
bytes: number;
|
|
31
|
+
external_refs: number;
|
|
32
|
+
package_members: number;
|
|
33
|
+
left_out: string[];
|
|
34
|
+
notices: number;
|
|
35
|
+
};
|
|
36
|
+
files: string[];
|
|
37
|
+
notes: string[];
|
|
38
|
+
next: string;
|
|
39
|
+
}>;
|
|
40
|
+
export declare function auditReportTool(s: Session, a: {
|
|
41
|
+
online?: boolean;
|
|
42
|
+
rerun?: boolean;
|
|
43
|
+
}): Promise<{
|
|
44
|
+
status: string;
|
|
45
|
+
summary: string;
|
|
46
|
+
passed: boolean;
|
|
47
|
+
checks: {
|
|
48
|
+
check: string;
|
|
49
|
+
status: string;
|
|
50
|
+
message: string;
|
|
51
|
+
}[];
|
|
52
|
+
report: string;
|
|
53
|
+
files: string[];
|
|
54
|
+
notes: string[];
|
|
55
|
+
next: string;
|
|
56
|
+
}>;
|
|
57
|
+
export declare function styleCheckTool(s: Session, a: {
|
|
58
|
+
report?: any;
|
|
59
|
+
min?: number;
|
|
60
|
+
}): {
|
|
61
|
+
status: string;
|
|
62
|
+
summary: string;
|
|
63
|
+
passed: boolean;
|
|
64
|
+
score: number;
|
|
65
|
+
target: number;
|
|
66
|
+
sentences: number;
|
|
67
|
+
compliant: number;
|
|
68
|
+
issues: {
|
|
69
|
+
sentence: string;
|
|
70
|
+
where: string;
|
|
71
|
+
issues: string[];
|
|
72
|
+
}[];
|
|
73
|
+
files: never[];
|
|
74
|
+
notes: never[];
|
|
75
|
+
};
|
|
76
|
+
export declare function scanSecretsTool(s: Session, a: {
|
|
77
|
+
sources?: string[];
|
|
78
|
+
}): {
|
|
79
|
+
status: string;
|
|
80
|
+
summary: string;
|
|
81
|
+
passed: boolean;
|
|
82
|
+
files_scanned: number;
|
|
83
|
+
hits: string[];
|
|
84
|
+
files: never[];
|
|
85
|
+
notes: never[];
|
|
86
|
+
};
|
|
87
|
+
export declare const TOOLS: ToolDef[];
|