chore(tooling): generation script for all language and clients APIC-221

.github/workflows/check.yml

@@ -39,19 +39,19 @@ jobs:
  uses: ./.github/actions/cache
 
  - name: Generate search client
- run: yarn generate:js:search
+ run: yarn generate javascript search
 
  - name: Build search client
  run: yarn client:build-js:search
 
  - name: Generate recommend client
- run: yarn generate:js:recommend
+ run: yarn generate javascript recommend
 
  - name: Build recommend client
  run: yarn client:build-js:recommend
 
  - name: Generate personalization client
- run: yarn generate:js:personalization
+ run: yarn generate javascript personalization
 
  - name: Build personalization client
  run: yarn client:build-js:personalization

README.md

@@ -14,16 +14,21 @@ nvm use && yarn
 yarn generate
 ```
 
+Generic command:
+```bash
+yarn generate <language | all> <client | all>
+```
+
 ### Search client
 
 ```bash
-yarn generate:search
+yarn generate all search
 ```
 
 ### Recommend client
 
 ```bash
-yarn generate:recommend
+yarn generate all recommend
 ```
 
 ## Build generated clients

package.json

@@ -25,19 +25,11 @@
  "cts:test": "yarn workspace tests test",
  "lint:client:fix": "eslint --ext=ts ${CLIENT} --fix",
  "lint": "eslint --ext=ts .",
- "format:specs": "yarn prettier --write specs",
- "generate:js:personalization": "yarn openapi-generator-cli generate --generator-key javascript-personalization && CLIENT=client-personalization yarn utils:import-js && CLIENT=clients/algoliasearch-client-javascript/client-personalization/ yarn lint:client:fix",
- "generate:js:recommend": "yarn openapi-generator-cli generate --generator-key javascript-recommend && CLIENT=recommend yarn utils:import-js && CLIENT=clients/algoliasearch-client-javascript/recommend/ yarn lint:client:fix",
- "generate:js:search": "yarn openapi-generator-cli generate --generator-key javascript-search && CLIENT=client-search yarn utils:import-js && CLIENT=clients/algoliasearch-client-javascript/client-search/ yarn lint:client:fix",
- "generate:js": "yarn generate:js:search && yarn generate:js:recommend && yarn generate:js:personalization",
- "generate:personalization": "yarn generate:js:personalization",
- "generate:recommend": "yarn generate:js:recommend",
- "generate:search": "yarn generate:js:search",
- "generate": "yarn generate:js && yarn format:specs",
+ "lint:specs:fix": "yarn prettier --write specs",
+ "generate": "./scripts/generate.sh ${0:-all} ${1:-all}",
  "playground:js:personalization": "yarn workspace javascript-playground start:personalization",
  "playground:js:recommend": "yarn workspace javascript-playground start:recommend",
  "playground:js:search": "yarn workspace javascript-playground start:search",
- "utils:import-js": "mkdir -p -- clients/algoliasearch-client-javascript/${CLIENT}/utils && cp -R clients/algoliasearch-client-javascript/utils/ clients/algoliasearch-client-javascript/${CLIENT}/utils",
  "validate": "yarn swagger-cli validate specs/dist/search.yml && yarn swagger-cli validate specs/dist/recommend.yml && yarn swagger-cli validate specs/dist/personalization.yml"
  },
  "devDependencies": {
@@ -54,6 +46,7 @@
  "eslint-plugin-jsdoc": "37.1.0",
  "eslint-plugin-prettier": "4.0.0",
  "eslint-plugin-unused-imports": "2.0.0",
+ "json": "11.0.0",
  "prettier": "2.5.0",
  "swagger-cli": "4.0.4",
  "typescript": "4.5.2"

scripts/generate.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# Break on non-zero code
+set -e
+
+LANGUAGE=$1
+CLIENT=$2
+
+LANGUAGES=(javascript)
+CLIENTS=(search recommend personalization)
+
+DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null && pwd)"
+# Move to the root (easier to locate other scripts)
+cd ${DIR}/..
+
+generate_client() {
+ local lang=$1
+ local client=$2
+ echo "Generating code for ${lang}-${client}"
+ yarn openapi-generator-cli generate --generator-key "${lang}-${client}"
+
+ # run the post generation script if it exists (linting and additional files)
+ local postgen="./scripts/post-gen/${lang}.sh"
+ if [[ -f "$postgen" ]]; then
+ $postgen $client
+ fi
+}
+
+if [[ $LANGUAGE == "all" ]]; then
+ LANGUAGE=("${LANGUAGES[@]}")
+elif [[ " ${LANGUAGES[*]} " =~ " ${LANGUAGE} " ]]; then
+ LANGUAGE=($LANGUAGE)
+else
+ echo "Unknown language ${LANGUAGE}"
+ exit 1
+fi
+
+if [[ $CLIENT == "all" ]]; then
+ CLIENT=("${CLIENTS[@]}")
+elif [[ " ${CLIENTS[*]} " =~ " ${CLIENT} " ]]; then
+ CLIENT=($CLIENT)
+else
+ echo "Unknown client ${CLIENT}"
+ exit 1
+fi
+
+for lang in "${LANGUAGE[@]}"; do
+ for client in "${CLIENT[@]}"; do
+ generate_client $lang $client
+ done
+done

scripts/post-gen/javascript.sh

@@ -0,0 +1,7 @@
+client=$1
+
+export CLIENT=$(cat openapitools.json | yarn json "generator-cli.generators.javascript-${client}.output" | sed 's/#{cwd}\///g')
+mkdir -p $CLIENT/utils
+cp -R clients/algoliasearch-client-javascript/utils/ $CLIENT/utils
+
+yarn lint:client:fix

yarn.lock

@@ -22,6 +22,7 @@ __metadata:
  eslint-plugin-jsdoc: 37.1.0
  eslint-plugin-prettier: 4.0.0
  eslint-plugin-unused-imports: 2.0.0
+ json: 11.0.0
  prettier: 2.5.0
  swagger-cli: 4.0.4
  typescript: 4.5.2
@@ -4264,6 +4265,15 @@ fsevents@^2.3.2:
  languageName: node
  linkType: hard
 
+"json@npm:11.0.0":
+ version: 11.0.0
+ resolution: "json@npm:11.0.0"
+ bin:
+ json: lib/json.js
+ checksum: 0beb8689722fc30251638543caf791bedc1a25199c18eb0281de115a0dadb00a07d4d36cbd7ff7680e04157fcb2bba76f29ed940b1e4e92f60c6fbaa74523fce
+ languageName: node
+ linkType: hard
+
 "jsonfile@npm:^6.0.1":
  version: 6.1.0
  resolution: "jsonfile@npm:6.1.0"