feat(embed): publish the code embed assets to npm

.github/workflows/publish-embed.yml

@@ -1,4 +1,4 @@
-name: Publish Snipcode embed assets to npmjs
+name: Publish Snipcode Embed assets to NPM
 on:
   push:
     branches: [main]
@@ -11,7 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v3
         with:
           node-version: '18.x'
@@ -21,11 +20,11 @@ jobs:
         uses: bahmutov/npm-install@v1
 
       - name: Publish to NPM
+        working-directory: packages/embed
         run: |
           yarn build:cdn
           cp package.publish.json build/package.json
+          cp README.publish.md build/README.md
           cd build
-          yarn publish
-        working-directory: packages/embed
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          npm config set //registry.npmjs.org/:_authToken ${{ secrets.NPM_TOKEN }}
+          yarn publish:lib

apps/core/.gitignore

@@ -77,6 +77,7 @@ typings/
 ../../packages/domain/.env.test
 .env*.local
 .env.docker
+.env.dev
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache

apps/functions/code-embed/package.json

@@ -27,7 +27,7 @@
     "@types/aws-lambda": "^8.10.102",
     "@types/node": "^17.0.45",
     "esbuild": "^0.15.5",
-    "serverless": "^3.22.0",
+    "serverless": "^3.36.0",
     "serverless-certificate-creator": "^1.6.0",
     "serverless-domain-manager": "^6.1.0",
     "serverless-esbuild": "^1.32.8",

packages/embed/README.md

@@ -69,14 +69,17 @@ yarn iframe:preview
 Navigate to the URL [http://localhost:7503](http://localhost:7503) to see the result.
 
 ## Publish the assets on NPM
-This part is handled inside the CI/CD, so it will not be useful to do it locally:
+This part is handled inside the CI/CD, so it will not be useful to do it locally.
+You will need the NPM access token; ask it to [@tericcabrel](https://github.com/tericcabrel))
+
 ```shell
 # Generate the assets optimized for production
 yarn build:cdn
 cp package.publish.json build/package.json
+cp README.publish.md build/README.md
 cd build
-# Authenticate to NPM
-npm adduser
+# Store the NPM access token 
+npm config set //registry.npmjs.org/:_authToken <npm_token>
 # Publish the package on NPM
 npm publish --access=public
 ```

packages/embed/README.publish.md

@@ -0,0 +1,10 @@
+# Snipcode Embed
+
+This package contains the script and style assets for code snippet rendering in an embed.
+
+To use it, include the CSS and JavaScript link to JSDelivr file.
+
+```html
+<link rel="stylesheet" type="text/css" href="https://jsdelivr.net/npm/@snipcode/[email protected]/style.min.css" />
+<script type="text/javascript" src="https://jsdelivr.net/npm/@snipcode/[email protected]/script.min.css"></script>
+```

packages/embed/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@snipcode/embed",
   "version": "1.0.0",
-  "main": "dist/index.js",
+  "description": "Build the script and style assets for code snippet rendering in an embed.",
   "repository": " https://github.com/tericcabrel/snipcode.git",
   "author": "Eric Cabrel TIOGO <[email protected]>",
   "license": "MIT",
@@ -14,7 +14,7 @@
     "dev": "nodemon --watch \"*.ts\" --exec \"ts-node\" ./src/server/index.ts",
     "lint": "eslint src",
     "iframe:preview": "serve ./src/server/static -l 7503",
-    "push": "cp package.publish.json build/package.json && cd build && npm publish --access=public",
+    "publish:lib": "cp package.publish.json build/package.json && cp README.publish.md build/README.md && cd build && npm publish --access=public",
     "test": "jest"
   },
   "devDependencies": {

packages/embed/package.publish.json

@@ -1,7 +1,15 @@
 {
-  "name": "snipcode-embed",
-  "version": "1.1.0",
-  "repository": "https://github.com/tericcabrel/snipcode.git",
-  "author": "Eric Cabrel TIOGO <[email protected]>",
-  "license": "MIT"
+  "name": "@snipcode/embed",
+  "version": "1.1.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tericcabrel/snipcode.git"
+  },
+  "homepage": "https://github.com/tericcabrel/snipcode/blob/main/packages/embed/README.md",
+  "author": "Eric Cabrel TIOGO",
+  "license": "MIT",
+  "keywords": ["code snippet", "snipcode", "snippets", "embed"],
+  "contributors": [
+    "Eric Cabrel TIOGO (https://github.com/tericcabrel)"
+  ]
 }