coderef
v2.0.0
Published
Link distant parts of your codebase together. Keep your source code in sync.
Downloads
4
Maintainers
Readme
Code-Ref
Keep distant parts of your code base in sync by using searchable cross-references.
It's a simple, yet powerful concept. Just run npx coderef
to copy a unique tag to your clipboard (like §SDyBm
), then use it to link different parts of your codebase together.
Example
someScript.js
const el = document.querySelector('#someElement')
const color = '#00f' // Search this project for §xRDEM to find other locations that use this color.
el.style.backgroundColor = color
pageStyle.css
body {
/* Search this project for §xRDEM to find other locations that use this color. */
color: #00f;
}
Anyone reading this code can know that if they use their favorite project-searching tool (via their editor, grep, etc), they can easily find all related pieces of code.
Happy Coding!
API
If for some reason you choose to install and import this package, you will find it exposes a single generate
function, which, when called, returns a randomly generated tag.
License
This project is under the MIT license.
Bug Reports/Feature Requests
This project's github repository can be found here. Bug reports and feature requests are welcome, and can be submitted on github.