https://github.com/yogeshnikam671/j2dc

A CLI tool to generate Kotlin data class code from a json string ( Json to Kotlin )
https://github.com/yogeshnikam671/j2dc

cli cli-app data-class jackson json json-to-kotlin kotlin nodejs

Last synced: about 14 hours ago
JSON representation

A CLI tool to generate Kotlin data class code from a json string ( Json to Kotlin )

• Host: GitHub
• URL: https://github.com/yogeshnikam671/j2dc
• Owner: yogeshnikam671
• License: mit
• Created: 2023-01-03T11:56:58.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T12:01:49.000Z (10 months ago)
• Last Synced: 2024-12-01T02:08:55.580Z (about 2 months ago)
• Topics: cli, cli-app, data-class, jackson, json, json-to-kotlin, kotlin, nodejs
• Language: JavaScript
• Homepage: https://github.com/yogeshnikam671/j2dc
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# j2dc

A CLI tool to convert JSON object into Kotlin data class

# Installation

To install this CLI tool, run the command `npm i -g j2dc`

# Usages

## Default behaviour

1. Copy the JSON you want to convert to kotlin data class to your clipboard.

2. Run the command `j2dc` in terminal.

3. You will see the resultant data class on terminal and the data class will also be automatically copied to your clipboard.

4. Now you don't have to explicitly copy the data class since it is already copied.

5. You can paste it in your kotlin file and use it.

## `-i` flag to take JSON as user input

1. Run the command `j2dc -i` in terminal.

2. It will open a vim session where you can input your JSON.

3. Once you provide the input, the resultant data class will be printed on terminal and also copied to clipboard.

## `-j` flag to get data class with Jackson annotations as output

1. Run the command `j2dc -j` in terminal.

2. This will return you data class with jackson annotations based on the json object copied in your clipboard.

3. The same data class will also be copied to your clipboard (default behaviour).

## `-n` flag to get data class with non nullable field types

1. In default behaviour, the data class output will always have nullable field types.

2. If you want the data types to be non-nullable, this flag can be passed. `j2dc -n`

## Misc

1. This tool does not understand `Double` or `Float` data types. It will always consider any number as `Int`.

   So in a case where you require the data type to be one of those, you will have to manually change the data types of those fields.

2. You can pass multiple flags at once : `j2dc -i -n -j`   

3. Pass the flag `--help` to understand how to use the tool.

# Troubleshooting

1. If you are getting the error `env: /usr/local/bin/node: No such file or directory`.

   - Run `which node`. This shows the node executable path in your machine.

   - Run `sudo cp  /usr/local/bin/node`. (temporary solution)

   - Now, run j2dc again. It should solve the issue.

# Roadmap

1. Add -s flag to get the output data class with keys in sorted manner.

2. Add support for Float/Double data types.