Skip to content

Commit b24d6c6

Browse files
authored
Merge pull request #13 from bingenito/readme-background
2 parents 824041d + 869df4b commit b24d6c6

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,25 @@
55
[![CI](https://github.com/morganstanley/url-detector/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/morganstanley/url-detector/actions/workflows/continuous-integration.yml)
66
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/morganstanley/url-detector/badge)](https://securityscorecards.dev/viewer/?uri=github.com/morganstanley/url-detector)
77

8-
A URL detection tool that scans files using Tree-sitter parsers for accurate URL discovery across 19+ programming languages. Instead of simple regex matching, this tool performs AST (Abstract Syntax Tree) parsing to precisely locate URLs in strings, comments, and other appropriate contexts.
8+
A URL detection tool that scans files using Tree-sitter parsers for accurate URL discovery across 20+ programming languages. Instead of simple regex matching, this tool performs AST (Abstract Syntax Tree) parsing to precisely locate URLs in strings, comments, and other appropriate contexts.
9+
10+
## The SBOM Gap
11+
12+
Software Bill of Materials (SBOM) generation has become critical for security and compliance, but traditional SBOM tools miss a significant category of external dependencies: URLs embedded directly in source code.
13+
14+
Modern package managers and dependency scanners excel at tracking managed dependencies (npm packages, Maven artifacts, etc.), but they can't detect legacy patterns like:
15+
16+
```html
17+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lodash.min.js"></script>
18+
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto">
19+
```
20+
21+
```javascript
22+
const API_ENDPOINT = "https://api.thirdparty.com/v1";
23+
fetch("https://analytics.example.com/track", { ... });
24+
```
25+
26+
These URLs represent real external dependencies that can impact security, availability, and compliance - but they won't appear in any SBOM generated from package metadata. URL Detector fills this gap by providing comprehensive URL inventory that complements traditional dependency tracking tools.
927

1028
## Features
1129

@@ -352,17 +370,6 @@ npm run lint
352370
npm run lint:fix
353371
```
354372

355-
## Contributing
356-
357-
1. Fork the repository
358-
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
359-
3. Add tests for new functionality
360-
4. Ensure all tests pass (`npm test`)
361-
5. Ensure code style is correct (`npm run lint`)
362-
6. Commit your changes (`git commit -m 'Add amazing feature'`)
363-
7. Push to the branch (`git push origin feature/amazing-feature`)
364-
8. Open a Pull Request
365-
366373
## License
367374

368375
Apache License 2.0 - see [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)