test(script): add jest for scripts package

scripts/jest.config.js

@@ -0,0 +1,6 @@
+/* eslint-disable import/no-commonjs */
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+ preset: 'ts-jest',
+ testEnvironment: 'node',
+};

scripts/package.json

@@ -5,7 +5,8 @@
  "build": "tsc",
  "createReleaseIssue": "yarn build && node dist/scripts/release/create-release-issue.js",
  "processRelease": "yarn build && node dist/scripts/release/process-release.js",
- "setHostsOptions": "yarn build && node dist/scripts/pre-gen/setHostsOptions.js"
+ "setHostsOptions": "yarn build && node dist/scripts/pre-gen/setHostsOptions.js",
+ "test": "jest"
  },
  "devDependencies": {
  "@octokit/rest": "18.12.0",
@@ -14,8 +15,10 @@
  "@types/semver": "7.3.9",
  "dotenv": "16.0.0",
  "execa": "5.1.1",
+ "jest": "27.4.7",
  "js-yaml": "4.1.0",
  "semver": "7.3.5",
+ "ts-jest": "27.1.3",
  "typescript": "4.5.4"
  }
 }

scripts/release/__tests__/common.test.ts

@@ -0,0 +1,63 @@
+import { getMarkdownSection } from '../common';
+
+describe('getMarkdownSection', () => {
+ it('gets the section correctly', () => {
+ const text = `
+ # hello
+
+ hi
+
+ # world
+
+ hey
+ `;
+ expect(getMarkdownSection(text, '# hello')).toMatchInlineSnapshot(`
+ "# hello
+
+ hi
+ "
+ `);
+ });
+
+ it('gets the sub headings', () => {
+ const text = `
+ # hi
+
+ # hello
+
+ ## sub-heading
+
+ hello
+
+ # this shouldn't be included
+
+ right?
+ `;
+
+ expect(getMarkdownSection(text, '# hello')).toMatchInlineSnapshot(`
+ "# hello
+
+ ## sub-heading
+
+ hello
+ "
+ `);
+ });
+
+ it('gets the whole text till the end', () => {
+ const text = `
+ # hi
+
+ # hello
+
+ this is a test
+ `;
+
+ expect(getMarkdownSection(text, '# hello')).toMatchInlineSnapshot(`
+ "# hello
+
+ this is a test
+ "
+ `);
+ });
+});

scripts/release/common.ts

@@ -36,3 +36,19 @@ export const LANGS = [
  )
  ),
 ];
+
+export function getMarkdownSection(markdown: string, title: string): string {
+ const levelIndicator = title.split(' ')[0]; // e.g. `##`
+ const lines = markdown
+ .slice(markdown.indexOf(title))
+ .split('\n')
+ .map((line) => line.trim());
+ let endIndex = lines.length;
+ for (let i = 1; i < lines.length; i++) {
+ if (lines[i].startsWith(`${levelIndicator} `)) {
+ endIndex = i;
+ break;
+ }
+ }
+ return lines.slice(0, endIndex).join('\n');
+}

scripts/release/process-release.ts

@@ -6,24 +6,11 @@ import execa from 'execa';
 
 import openapitools from '../../openapitools.json';
 
-import { MAIN_BRANCH, OWNER, REPO, run } from './common';
+import { MAIN_BRANCH, OWNER, REPO, run, getMarkdownSection } from './common';
 import TEXT from './text';
 
 dotenv.config();
 
-function getMarkdownSection(markdown: string, title: string): string {
- const levelIndicator = title.split(' ')[0]; // e.g. `##`
- const lines = markdown.slice(markdown.indexOf(title)).split('\n');
- let endIndex = lines.length;
- for (let i = 1; i < lines.length; i++) {
- if (lines[i].startsWith(`${levelIndicator} `)) {
- endIndex = i;
- break;
- }
- }
- return lines.slice(0, endIndex).join('\n');
-}
-
 if (!process.env.GITHUB_TOKEN) {
  throw new Error('Environment variable `GITHUB_TOKEN` does not exist.');
 }

scripts/tsconfig.json

@@ -2,6 +2,7 @@
  "extends": "../base.tsconfig.json",
  "compilerOptions": {
  "typeRoots": ["../node_modules/@types"],
+ "types": ["node", "jest"],
  "outDir": "dist"
  },
  "include": ["pre-gen/setHostsOptions.ts", "release/*"],

yarn.lock

@@ -9987,8 +9987,10 @@ __metadata:
  "@types/semver": 7.3.9
  dotenv: 16.0.0
  execa: 5.1.1
+ jest: 27.4.7
  js-yaml: 4.1.0
  semver: 7.3.5
+ ts-jest: 27.1.3
  typescript: 4.5.4
  languageName: unknown
  linkType: soft