Skip to content

Commit

Permalink
prepare for publish of version 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
onora-hbl committed Feb 11, 2022
1 parent 31c2810 commit 5101ff1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,25 @@
- [Table of content](#table-of-content)
- [Road Map](#roadmap)
- [Documentation](#documentation)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
- [Contributing](#contributing)
# RoadMap
- Automaticaly add 42 header
- Give the choice to create constructors with only certain fields
- Inheritance managing
- Class' excpetions
- All the features that I find useful ;)
# Documentation
## Installation
Until we make the extension cleaner, it is not available directly on VSCode store. To install it, use the commans `code --install-extension 42CppClassGenerator-0.0.1.vsix` with the version you can find in the release. If you want to compile it from the source, you can use `vsce package --baseContentUrl none --baseImagesUrl none` command
## Usage

- Open the generator pannel with the command `open C++ orthodox canonical class generator`
- Choose a class name (as `MySuperClass`)
- Choose a class name (like `MySuperClass`)
- You can add all the fields you want
- For the type, precise `std` if needed. Examples: `std::string` or `int`
- Choose a name without the `_` (as `mySuperInt`)
- For the type, precise `std` if needed. Examples: `std::string` or `int`
- Choose a name without the `_` (like `mySuperInt`)
- It's not mandatory to add a default value to the field
- You can add classe's exceptions
- Precise the name (like `MySuperException`)
- Precise whatever you want in the `what` function
- If you fill it, you cann add the overload of the `<<` operator (use the precised format to print some field in the message)
- You can generate debug message in constructor/destructor if the subject ask it

# Contributing
The major problem at the moment is the interface. I am not a frontend developer and my code is very ugly. Feel free to make a PR to improve the interface (in `src/GuiGenerator.ts`). But you can participate on any part of the code to propose an improvement
PR are welcome on Github to propose an improvement
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "cppclassgenerator",
"displayName": "42 C++ Orthodox Canonical Form Class Generator",
"description": "Automatic generation of C++ classes in orthodox canonical form for 42's projects",
"version": "1.0.0",
"version": "1.1.0",
"publisher": "Damien Hubleur",
"license: ": "SEE LICENSE IN license.txt",
"icon": "resources/logo.png",
Expand All @@ -11,7 +11,7 @@
"url": "https://github.com/dams333/CPP_Class_Generator"
},
"engines": {
"vscode": "^1.63.0"
"vscode": "^1.64.0"
},
"categories": [
"Formatters",
Expand Down Expand Up @@ -67,7 +67,6 @@
"webpack-cli": "^4.9.1"
},
"dependencies": {
"vsce": "^2.6.7",
"vscode": "^1.1.37"
"vsce": "^2.6.7"
}
}

0 comments on commit 5101ff1

Please sign in to comment.