stoplightio · philsturgeon · Apr 3, 2017 · Apr 9, 2017 · Apr 9, 2017 · May 22, 2020
diff --git a/.editorconfig b/.editorconfig
@@ -9,5 +9,15 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
+[targets/**/fixtures/*]
+insert_final_newline = false
+
+[**/http1.1/fixtures/*]
+end_of_line = crlf
+insert_final_newline = false
+
+[**/http1.1/fixtures/jsonObj-multiline]
+end_of_line = unset
+
 [*.md]
 trim_trailing_whitespace = false
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,3 @@
+src/targets/**/fixtures
+dist
+bin
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,30 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  env: {
+    node: true,
+  },
+  parserOptions: {
+    project: 'tsconfig.json',
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:jest/all',
+    'plugin:jest-formatting/strict',
+    'plugin:eslint-comments/recommended',
+    'prettier',
+  ],
+  plugins: ['eslint-comments', 'simple-import-sort', 'jest', 'jest-formatting'],
+  rules: {
+    'prefer-template': 'error',
+    'no-else-return': 'error',
+    '@typescript-eslint/no-explicit-any': 'off',
+    'eslint-comments/require-description': 'error',
+    'eslint-comments/disable-enable-pair': 'off',
+    'simple-import-sort/imports': 'error',
+    'simple-import-sort/exports': 'error',
+    'jest/prefer-expect-assertions': 'off',
+    'jest/require-hook': 'off',
+  },
+};
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+targets/http/http1.1/fixtures text
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,94 @@
+name: Build and Publish Httpsnippet
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*' # Restrict any specific tag formats
+  pull_request:
+    types:
+      - opened
+      - synchronize
+  workflow_dispatch:
+
+jobs:
+  scan:
+    permissions:
+      packages: write
+      contents: write # publish sbom to GH releases/tag assets
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v3
+        with:
+          path: ${{ github.repository }}
+
+      # Perform SCA analysis for the code repository
+      # Produces SBOM and CVE report
+      # Helps understand vulnerabilities / license compliance across third party dependencies
+      - id: sca-project
+        uses: Kong/public-shared-actions/security-actions/sca@a18abf762d6e2444bcbfd20de70451ea1e3bc1b1
+        with:
+          dir: ${{ github.repository }}
+          upload-sbom-release-assets: true
+
+  build:
+    needs: [scan]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [16, 18, 20]
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install
+        run: npm ci
+
+      - name: Test
+        run: npm run test
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build
+        run: npm run build
+
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write # For using token to sign images
+      actions: read # For getting workflow run info to build provenance
+      packages: write # Required for publishing provenance. Issue: https://github.com/slsa-framework/slsa-github-generator/tree/main/internal/builders/container#known-issues
+    if: ${{ github.ref_type == 'tag' && github.repository_owner == 'Kong' }}
+    steps:
+      # checkout tag
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.9.0
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to NPM
+        run: npm publish --no-git-checks --provenance --tag ${{ github.sha }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,58 @@
+name: Release httpsnippet
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Tag version to release'
+        required: true
+
+env:
+  # Release Tag to build and publish
+  TAG: ${{ github.event.inputs.version }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT_INSOMNIA_INFRA }}
+
+      - name: Configure Git user
+        uses: Homebrew/actions/git-user-config@266845213695c3047d210b2e8fbc42ecdaf45802 # master
+        with:
+          username: ${{ (github.event_name == 'workflow_dispatch' && github.actor) || 'insomnia-infra' }}
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install
+        run: npm ci
+
+      - name: Create new package version
+        run: npm version "${{ env.TAG }}"
+
+      - name: DEBUG see tags
+        run: |
+          git tag --list
+          git remote -v
+
+      - name: Merge version commit into master
+        run: |
+          git push origin v${{ env.TAG }}
+          git push origin master
+
+      - name: Create Tag and Release
+        uses: ncipollo/release-action@440c8c1cb0ed28b9f43e4d1d670870f059653174 # v1
+        id: core_tag_and_release
+        with:
+          tag: v${{ env.TAG }}
+          name: 'httpsnippet v${{ env.TAG }} 📦'
+          generateReleaseNotes: true
+          prerelease: false
+          draft: false
diff --git a/.github/workflows/sast.yml b/.github/workflows/sast.yml
@@ -0,0 +1,25 @@
+name: SAST
+
+on:
+  pull_request: {}
+  push:
+    branches:
+      - master
+  workflow_dispatch: {}
+
+jobs:
+  semgrep:
+    name: Semgrep SAST
+    runs-on: ubuntu-latest
+    permissions:
+      # required for all workflows
+      security-events: write
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    if: (github.actor != 'dependabot[bot]')
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: Kong/public-shared-actions/security-actions/semgrep@a18abf762d6e2444bcbfd20de70451ea1e3bc1b1
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.log
 node_modules
 coverage*
+dist
diff --git a/.jshintrc b/.jshintrc
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,28 @@
+# see https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for docs
+
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+# MD004 - Unordered list style
+# We want to use dashes consistently everywhere
+MD004:
+  style: dash
+
+# MD013 - Line length
+# We do not want to artificially limit line lengh in a language like markdown because of the nature of the language's handling of whitespace.  Line wrapping is just a fact of life in markdown and trying to impose the conventions of other languages on markdown is an impedance mismatch that leads to people thinking that whitespace in markdown is more representative of the rendered HTML than it really is.
+MD013: false
+
+# MD033 - Inline HTML
+MD033:
+  allowed_elements:
+    - details # there is no markdown equivalent for accordions
+    - summary # there is no markdown equivalent for accordions
+    - pre # necessary for code fences in markdown tables
+
+# MD029 - Ordered list item prefix
+# Plain and simple, markdown parsers do not respect the numbering you use for ordered lists.  It only leads to confusion and misconception to allow otherwise.
+MD029:
+  style: one
diff --git a/.npmignore b/.npmignore
@@ -1,3 +1,7 @@
-.jshintrc
-.editorconfig
-test
+# Ignore everything by default
+# NOTE: NPM publish will never ignore package.json, package-lock.json, README, LICENSE, CHANGELOG
+# https://npm.github.io/publishing-pkgs-docs/publishing/the-npmignore-file.html
+*
+
+# Don't ignore dist folder
+!dist/**
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+20
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+build
+node_modules
+src/targets/**/fixtures
+dist
+bin
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,16 @@
+/** @type { import('prettier').Config } */
+module.exports = {
+  arrowParens: 'avoid',
+  bracketSameLine: false,
+  bracketSpacing: true,
+  jsxSingleQuote: false,
+  printWidth: 100,
+  proseWrap: 'never',
+  quoteProps: 'as-needed',
+  semi: true,
+  singleAttributePerLine: true,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+  useTabs: false,
+};
diff --git a/.travis.yml b/.travis.yml
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["EditorConfig.EditorConfig"]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+  "files.insertFinalNewline": false, // controlled by the .editorconfig at root since we can't map vscode settings directly to files (see: https://github.com/microsoft/vscode/issues/35350)
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}