Removes dynamic leading substring
- ✨ Benefits
- 🎒 Requierments
- 🚀 Quickstart
- 📘 Documentation
- 🆘 Troubleshooting
- 🤝 Contributing
- 🧪 Testing
- ⚖️ License
- Match user input strings (unknown at time of coding)
- Avoid issues with special chars
- Improve readability compared to regex
No requierments, just works.
Install using the terminal:
npm install @danielcobo/rmleading
Require the module:
const rmleading = require('@danielcobo/rmleading');
Note: In case you're wondering, @danielcobo/ is just a namespace scope - an NPM feature. Scopes make it easier to name modules and improve security.
Declare it as a global variable named rmleading by including this script before any script you want to use it in:
<script src="https://cdn.jsdelivr.net/npm/@danielcobo/rmleading@1/dist/iife/rmleading.min.js"></script>
Or import it as an ECMAScript module:
import * as rmleading from 'https://cdn.jsdelivr.net/npm/@danielcobo/rmleading@1/dist/esm/rmleading.min.js';
Also, feel free to download the file if you prefer not to use jsdelivr. In that case just replace the url with the relative file path.
const slash = '/';
rmLeading('/hello/world', slash); //'hello/world',
rmLeading('//hello/world', slash); //'hello/world'
rmLeading('hello/world', slash) //'hello/world'
rmLeading('///', slash); //''
rmLeading('', slash) //''
For details see documentation below.
Remove leading substring
Name | Type | Default | Description |
---|---|---|---|
str | string |
Input string | |
substr | string |
Leading string to remove | |
[flag] | string |
'i' for case insensitive |
Type | Description |
---|---|
string |
Input string without the leading substring |
Source: src/index.js:1
If you run into trouble or have questions just submit an issue.
Contributions come in many shapes and sizes. All are welcome. You can contribute by:
- asking questions
- suggesting features
- sharing this repo with friends
- improving documentation (even fixing typos counts 😉)
- providing tutorials (if you do, please let me know, I would love to read them)
- improving tests
- contributing code (new features, performance boosts, code readability improvements..)
General guidelines:
- there are no dumb questions
- be polite and respectful to others
- do good
When coding remember:
- working > maintainability > performance
- best code is no code
- be descriptive when naming
- keep it DRY
- do test
Contribution licence: All contributions are considered to be under same license as this repository.
Testing suite: 🃏 Jest | Test command: npm test
Mutation testing suite: 👽 Stryker Mutator | Mutation test command: npm run mutation
If you intend to develop further or contribute code, then please ensure to write and use testing. Strive for 100% code coverage and high mutation scores. Mutation score 100 is great, but it's not always neccessary (if there are valid reasons).