@devkong/cli-nx 0.0.3 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devkong/cli-nx",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",

package/src/generators/preset/files/python/.gitignore.template

@@ -0,0 +1,69 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+dist
+bin
+tmp
+/out-tsc
+**/target
+
+# dependencies
+node_modules
+.nx
+.poetry
+.venv
+
+# IDEs and editors
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+.kotlin
+**/pylint.txt
+.pytest_cache
+__pycache__
+
+# System Files
+.DS_Store
+Thumbs.db
+
+# Gradle
+.gradle
+build
+
+# Maven
+**/.mvn/repository
+
+# Idea
+**/.idea/aws.xml
+**/.idea/dataSources
+**/.idea/dataSources.local.xml
+**/.idea/dataSources.xml
+**/.idea/httpRequests
+**/.idea/jarRepositories.xml
+**/.idea/jsLibraryMappings.xml
+**/.idea/kotlinScripting.xml
+**/.idea/modules
+**/.idea/modules.xml
+**/.idea/protoeditor.xml
+**/.idea/protoeditor.xml
+**/.idea/shelf
+**/.idea/tasks.xml
+**/.idea/workspace.xml
+
+# tests
+**/.coverage
+**/coverage.xml
+**/reports/**/unittests

package/src/generators/preset/files/python/README.md

@@ -1,63 +1,98 @@
-# kong-extension
+# Kong Extension
 
-Welcome to the kong extension development workspace!
+Welcome to the Kong extension development workspace!
 
 ### Prerequisites
 
-- install [docker](https://docs.docker.com/engine/install/)
-- install [nodejs](https://nodejs.org/en/download), version >= 20.0
-- install [python](https://www.python.org/downloads/), version >= 3.9
-- add your user name to the `ownership` field in the `kong.json` file
-- to configure an environment, run the following command:
+Before you start, make sure you have the following installed:
+
+- [Node.js](https://nodejs.org/en/download), version >= 20.0
+- [Python](https://www.python.org/downloads/), version >= 3.9
+- [Docker](https://docs.docker.com/engine/install/)
+
+To verify the installation and check the versions, run the following commands:
 
 ```shell script
-kong configure
+node --version
+python --version
+docker info
 ```
 
-### Update Dependencies
+### Getting Started
 
-After modifying requirements.txt or requirements-dev.txt, run the following command to apply the changes:
+1. Add your username to the `ownership` field in the `kong.json` file (e.g., "kong-dev", "kong-qa")
+2. Make sure you're in the terminal and inside the extension folder you generated
+3. Run the following commands in your terminal:
 
-```
-kong install
+```shell script
+# configure the base Kong URL (e.g., https://kong.dev.app-dts.net)
+kong configure
+
+# install Python dependencies from requirements.txt
+kong install --verbose
 ```
 
-### Update CLI
+That's it! Now, modify your code, tag it by publishing a new version, and assign aliases for use in the workflow.
 
-To install the latest CLI version use the following command:
+### Publish a New Version
+
+To automatically tag your code with an incremented version number (e.g., 1, 2, 3), run:
 
 ```shell script
-npm i -g @devkong/cli@latest
+kong publish-version --verbose
 ```
 
-### Publish the Extension Version
+This command will build your extension and tag it with the next available version.
+
+### List Available Versions
 
-Next command will automatically tag the code with an incremented version number (e.g., 1, 2, 3):
+To see all available versions of your extension, run:
 
 ```shell script
-kong publish-version
+kong list-versions
 ```
 
-This will build the extension and tags it with the next available version. If it’s the first version, it will be tagged as version 1.
-
 ### Assign an Alias to a Version
 
-You can assign an alias(good names: `stable`, `beta`) to a particular version. This alias will accessible in the UI as a separate step in workflow. For example, to assign the alias stable to version 1, use the following command:
+You can assign an alias (e.g., stable, beta) to a specific version. This alias will appear in the UI as a separate step in the workflow. For example, to assign the alias stable to version 1, use:
 
 ```shell script
-kong set-alias stable 1
+kong set-alias stable 1 --verbose
 ```
 
-This will assign the alias stable to version 1 of your extension.
+### Running and Debugging Tests
 
-### List Available Versions
+To run the tests, execute the following command:
 
-You can list all available versions and aliases of your extension by running:
+```shell script
+pytest ./src
+```
+
+This will run the tests located in the `src` directory.
+The debugging process depends on the IDE you're using. For example, in [VSCode](https://code.visualstudio.com/), follow these steps:
+
+1. Open the Run and Debug panel from the left sidebar
+2. In the top combobox (dropdown), select "test" to configure the test environment
+3. Click the green play button to start debugging the tests
+
+This will allow you to set breakpoints and step through your tests.
+
+### Update Python Dependencies
+
+If you modify requirements.txt or requirements-dev.txt, run the following to apply the changes:
 
 ```shell script
-kong list-versions
+kong install --verbose
 ```
 
 ### Using a Custom Profile
 
-To use a profile other than the default, include the `--profile <name>` parameter when executing the CLI command.
+If you're developing an extension that will be used in different regions (or need to work with a specific profile), you can create a new profile using `kong configure`. Then, include the `--profile <name>` parameter when running the publish-version and set-alias commands to use the desired profile.
+
+### Update CLI
+
+To install the latest version of the CLI, run:
+
+```shell script
+npm i -g @devkong/cli@latest
+```