Publish Library on NPM (#581)

.github/workflows/release.yaml

@@ -23,6 +23,11 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.RELEASE_TOKEN }}
 
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '21.x'
+          registry-url: 'https://registry.npmjs.org/'
+
       - name: Name and Email for Git (config)
         run: |
           git config --local user.email "action@github.com"
@@ -45,6 +50,19 @@ jobs:
         env:
           RELEASE_TOKEN: ${{ secrets.RELEASE_TOKEN }}
 
+      - name: Ensure up-to-date Dependencies
+        run: npm ci
+
+      - name: Publish on NPM
+        # we use publish library because flowr itself is a runnable, and we do not want to publish something with extra
+        # dist paths etc.
+        # besides, we make dead-sure we have a clean directory to work on!
+        run: |
+          rm -rf dist
+          npm publish-library
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+
   performance-test:
     name: "Performance Test"
     needs: ['release']

.npmignore

@@ -0,0 +1,23 @@
+node_modules/
+
+/wiki
+
+# Logs
+*.log
+
+.git*
+
+# Coverage
+/.nyc_output
+/coverage
+
+# IDE specific
+/.vscode/
+/.project/
+/.settings/
+
+/.DS_Store
+src/**
+test/**
+**/*.map
+.idea/

package.json

@@ -1,9 +1,19 @@
 {
-  "name": "flowr",
+  "name": "@code-inspect/flowr",
   "version": "1.3.7",
-  "description": "Program Slicer and Analyzer for R Programs",
+  "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "main": "dist/src/flowr.js",
+  "types": "dist/src/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Code-Inspect/flowr.git"
+  },
+  "homepage": "https://github.com/Code-Inspect/flowr",
+  "bugs": {
+    "url": "https://github.com/Code-Inspect/flowr/issues"
+  },
   "scripts": {
+    "publish-library": "cp .npmignore package.json README.md LICENSE dist/src/ && cd dist/src && npm publish --provenance --access public",
     "main": "ts-node src/flowr.ts",
     "stats": "ts-node src/cli/statistics-app.ts",
     "stats-helper": "ts-node src/cli/statistics-helper-app.ts",
@@ -22,7 +32,14 @@
     "performance-test": "func() { cd test/performance/ && bash run-all-suites.sh $1 $2; cd ../../; }; func",
     "test-full": "npm run test -- --test-installation"
   },
-  "keywords": [],
+  "keywords": [
+    "static code analysis",
+    "R programming language",
+    "R",
+    "programming",
+    "slicing",
+    "dataflow analysis"
+  ],
   "author": "Florian Sihler",
   "license": "ISC",
   "nyc": {

src/index.ts

@@ -0,0 +1,6 @@
+export * from './core'
+export * from './slicing'
+export * from './dataflow'
+export * from './r-bridge'
+export * from './benchmark'
+export * from './statistics'

tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "incremental": true,
     "esModuleInterop": true,
+    "declaration": true,
     "resolveJsonModule": true,
     "target": "ESNext",
     "module": "commonjs",
@@ -13,7 +14,7 @@
   },
   "lib": [ "esnext", "dom" ],
   "exclude": [
-    "node_modules",
-    "node_modules/*"
+    "node_modules/**/*",
+    "dist/**/*"
   ]
 }