{"_id":"@brokkr/doc-tester","_rev":"2-34c864aba8b7be65a420d3358b81a6c2","name":"@brokkr/doc-tester","dist-tags":{"latest":"0.15.2"},"versions":{"0.15.0":{"name":"@brokkr/doc-tester","version":"0.15.0","author":{"url":"https://gurunars.com","name":"Anton Berezin","email":"gurunars@gmail.com"},"license":"Apache-2.0","_id":"@brokkr/doc-tester@0.15.0","maintainers":[{"name":"gurunars","email":"gurunars@gmail.com"}],"homepage":"https://github.com/spec-validator/validator","bugs":{"url":"https://github.com/spec-validator/validator/issues"},"bin":{"test-docs":"runCodeBlocks.js"},"dist":{"shasum":"2eb8b59e483dcf74fb6e4c8368269162f61bebeb","tarball":"https://registry.npmjs.org/@brokkr/doc-tester/-/doc-tester-0.15.0.tgz","fileCount":12,"integrity":"sha512-O+9cDdCUfnNlFODO+yNfe9hjLTf7M6jA1CpPVqFrTZCqa2rEKWm7T6YybmhPC6Qki7/sXzIHZgCIi3LHgvJLig==","signatures":[{"sig":"MEYCIQCpOLaVmc7zBztL7jBgcQWJyP1RMBsWnrygWTD15tq44gIhAMdMDBG78uYJJijiEijMfz50OcvTNPFgxbo//w7yCyTx","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13897},"private":false,"_npmUser":{"name":"gurunars","email":"gurunars@gmail.com"},"repository":{"url":"https://github.com/spec-validator/validator.git","type":"git"},"description":"Internally extracts typescript code from '`ts/typescript`' code blocks and feeds those to `ts-node`. Line mapping is done accordingly to indicate the locations of the errors within the source Markdown files.","directories":{},"dependencies":{"ts-node":"^10.9.2","tsconfig-paths":"^4.2.0"},"publishConfig":{"registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-tester_0.15.0_1735549840507_0.36190135297245685","host":"s3://npm-registry-packages-npm-production"}},"0.15.1":{"name":"@brokkr/doc-tester","version":"0.15.1","author":{"url":"https://gurunars.com","name":"Anton Berezin","email":"gurunars@gmail.com"},"license":"Apache-2.0","_id":"@brokkr/doc-tester@0.15.1","maintainers":[{"name":"gurunars","email":"gurunars@gmail.com"}],"homepage":"https://github.com/brokkr/validator","bugs":{"url":"https://github.com/brokkr/validator/issues"},"bin":{"test-docs":"runCodeBlocks.js"},"dist":{"shasum":"fc63b721878c1fb98c8e86a47b953b3788ff3a27","tarball":"https://registry.npmjs.org/@brokkr/doc-tester/-/doc-tester-0.15.1.tgz","fileCount":12,"integrity":"sha512-r3Mos+8Y1L/bh2I2TZX4C5tC09Y6SE2CCdnkpPhPFLpQ3syxnTrEe9ILyg1IBAzplbVL3VK5noYvT9IVxzqQSw==","signatures":[{"sig":"MEYCIQCMtbGlhCJJ1ULzosXRyxKRTjU1r7XeoLwub6fWZ3UPEgIhANkYsh+KE7fiZN1NeDZri/PSHPCt07BxEdy3Fwho5eGb","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13873},"private":false,"_npmUser":{"name":"gurunars","email":"gurunars@gmail.com"},"repository":{"url":"https://github.com/brokkr/validator.git","type":"git"},"description":"Internally extracts typescript code from '`ts/typescript`' code blocks and feeds those to `ts-node`. Line mapping is done accordingly to indicate the locations of the errors within the source Markdown files.","directories":{},"dependencies":{"ts-node":"^10.9.2","tsconfig-paths":"^4.2.0"},"publishConfig":{"registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/doc-tester_0.15.1_1735556562260_0.437443432588545","host":"s3://npm-registry-packages-npm-production"}},"0.15.2":{"name":"@brokkr/doc-tester","version":"0.15.2","dependencies":{"ts-node":"^10.9.2","tsconfig-paths":"^4.2.0"},"bin":{"test-docs":"runCodeBlocks.js"},"license":"Apache-2.0","author":{"name":"Anton Berezin","email":"gurunars@gmail.com","url":"https://gurunars.com"},"publishConfig":{"registry":"https://registry.npmjs.org/"},"repository":{"url":"https://github.com/brokkr/validator.git","type":"git"},"bugs":{"url":"https://github.com/brokkr/validator/issues"},"homepage":"https://github.com/brokkr/validator","private":false,"description":"Internally extracts typescript code from '`ts/typescript`' code blocks and feeds those to `ts-node`. Line mapping is done accordingly to indicate the locations of the errors within the source Markdown files.","_id":"@brokkr/doc-tester@0.15.2","dist":{"shasum":"e7b5ac932b2c7937f8c699e1936d2cd6bb370066","integrity":"sha512-UtHtmCgyVxjmSH77kse0u1/j7FVHYUQvZwDNSTiz/TsEOPb4mekqUFZPAi3K0PToBfT40SYD6cH6r8nIaGzkpw==","tarball":"https://registry.npmjs.org/@brokkr/doc-tester/-/doc-tester-0.15.2.tgz","fileCount":12,"unpackedSize":13873,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGTsM9MRyFMtt/wnzviwXRzxJTd3p7XjrhwQ2fF6FQSsAiEAi5K6S8sw6di0jbwKQMk1tsqmbslyM1I73N95NaUqwaw="}]},"_npmUser":{"name":"gurunars","email":"gurunars@gmail.com"},"directories":{},"maintainers":[{"name":"gurunars","email":"gurunars@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/doc-tester_0.15.2_1735643499962_0.29171863926071606"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-30T09:10:40.365Z","modified":"2024-12-31T11:11:40.310Z","0.15.0":"2024-12-30T09:10:40.725Z","0.15.1":"2024-12-30T11:02:42.462Z","0.15.2":"2024-12-31T11:11:40.128Z"},"bugs":{"url":"https://github.com/brokkr/validator/issues"},"author":{"name":"Anton Berezin","email":"gurunars@gmail.com","url":"https://gurunars.com"},"license":"Apache-2.0","homepage":"https://github.com/brokkr/validator","repository":{"url":"https://github.com/brokkr/validator.git","type":"git"},"description":"Internally extracts typescript code from '`ts/typescript`' code blocks and feeds those to `ts-node`. Line mapping is done accordingly to indicate the locations of the errors within the source Markdown files.","maintainers":[{"name":"gurunars","email":"gurunars@gmail.com"}],"readme":"# @brokkr/doc-tester\n\nInternally extracts typescript code from '`ts/typescript`' code\nblocks and feeds those to `ts-node`. Line mapping is done accordingly\nto indicate the locations of the errors within the source\nMarkdown files.\n\n## Run\n\n`ỳarn test-docs`\n\n## Expected Markdown format\n\nTo denote a code block just write:\n\n<code>\n\n\\```ts\n\nconst foo = 'On a separate line'\n\n\\```\n\n</code>\n\nThe blocks can be additionally labeled to avoid definition collisions:\n\n<code>\n\n\\```ts label-one\n\nconst foo = 'One'\n\n\\```\n\n\\```ts label-two\n\nconst foo = 'Another'\n\n\\```\n\n\\```ts label-three\n\nconst foo = 'Yet Another'\n\n\\```\n\n</code>\n\nthis notifies the tool that definition scopes should be different thus\n`const` collision will not takes place.\n\nIn case if the block should not be executed - mark it with a label\nstarting with `#` (useful if execution will yield side-effects).\n\n<code>\n\n\\```ts #ignore\n\nserver.serve()\n\n\\```\n\n</code>\n\n## Known limitiations\n\n1. By design ignores any non typescript blocks.\n1. By design ignores any non-multiline blocks (i.e. triple quotes must live on their own lines).\n1. Works only with triple quote blocks. `<code>` blocks are ignored.\n1. Does not affest Jest's code coverage in any way\n","readmeFilename":"README.md"}