@tarsislimadev/csv2json
v0.1.0
Published
A simple and efficient tool to convert CSV files to JSON format
Downloads
6
Readme
@tarsislimadev/csv2json
A simple and efficient tool to convert CSV files to JSON format.
Installation
Using NPX (Recommended)
npx @tarsislimadev/csv2json input.csv output.jsonUsing NPM
npm install -g @tarsislimadev/csv2json
csv2json input.csv output.jsonLocal Installation
npm install
npm start input.csv output.json
# or
npm run convert input.csv output.jsonUsage
Command Line
csv2json <input-file> [output-file]Parameters:
input-file(required): Path to the CSV file to convertoutput-file(optional): Path for the output JSON file (defaults to./file.json)
Examples
Convert a CSV file to JSON with default output name:
csv2json data.csv
# Creates file.jsonConvert a CSV file to JSON with custom output name:
csv2json data.csv output.json
# Creates output.jsonUsing NPX without installation:
npx @tarsislimadev/csv2json sales.csv sales.jsonInput Format
The tool expects CSV files with:
- Comma-separated values
- First row as headers (column names)
- Windows-style line endings (
\r\n)
Example CSV Input:
name,age,city
John,25,New York
Jane,30,Los Angeles
Bob,35,ChicagoOutput Format
The tool generates a JSON array where each object represents a row from the CSV:
Example JSON Output:
[
{
"name": "John",
"age": "25",
"city": "New York"
},
{
"name": "Jane",
"age": "30",
"city": "Los Angeles"
},
{
"name": "Bob",
"age": "35",
"city": "Chicago"
}
]Features
- ✅ Simple command-line interface
- ✅ Automatic header detection
- ✅ Pretty-formatted JSON output
- ✅ NPX support for instant usage
- ✅ Cross-platform compatibility
Requirements
- Node.js (any recent version)
Scripts
npm start- Run the converternpm run convert- Alternative command to run the converternpm test- Placeholder for tests
License
MIT
Author
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Issues
If you encounter any issues, please report them on the GitHub Issues page.
