Merge pull request #78 from sasjs/issue77

Issue77

.github/workflows/build.yml

@@ -21,7 +21,13 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm run package:lib
+      - name: Install Dependencies
+        run: npm ci
+      - name: Check code style
+        run: npm run lint
+      - name: Run unit tests
+        run: npm test
+      - name: Build Package
+        run: npm run package:lib
         env:
           CI: true

.github/workflows/npmpublish.yml

@@ -16,6 +16,8 @@ jobs:
         uses: actions/checkout@v2
       - name: Install Dependencies
         run: npm ci
+      - name: Check code style
+        run: npm run lint
       - name: Build Project
         run: npm run build
       - name: Semantic Release

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true
+}

CONTRIBUTING.md

@@ -1,80 +1,31 @@
 # Contributing
 
-Contributions to SASjs are very welcome!  When making a PR, test cases should be included.  To help in unit testing, be sure to run the following when making changes:
+Contributions to SASjs are very welcome! When making a PR, test cases should be included.
 
-```
-# the following creates a tarball in the build folder of SASjs
-npm run-script package:lib
+## Code Style
 
-# now go to your app and run:
-npm install ../sasjs/build/<tarball filename>
-```
+This repository uses `Prettier` to ensure a uniform code style.
+If you are using VS Code for development, you can automatically fix your code to match the style as follows:
 
-Tests are run using cypress.  Before running tests, you need to define the following backend services:
+- Install the `Prettier` extension for VS Code.
+- Open your `settings.json` file by choosing 'Preferences: Open Settings (JSON)' from the command palette.
+- Add the following items to the JSON.
+  ```
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+  ```
 
-# SAS 9
-```
+If you are using another editor, or are unable to install the extension, you can run `npm run lint:fix` to fix the formatting after you've made your changes.
 
-filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/mc_all.sas?_=1";
-%inc mc;
-filename ft15f001 temp;
-parmcards4;
-  %webout(OPEN)
-  %macro x();
-  %do i=1 %to &_webin_file_count; %webout(OBJ,&&_webin_name&i) %end;
-  %mend; %x()
-  %webout(CLOSE)
-;;;;
-%mm_createwebservice(path=/Public/app/common,name=sendObj)
-parmcards4;
-  %webout(OPEN)
-  %macro x();
-  %do i=1 %to &_webin_file_count; %webout(ARR,&&_webin_name&i) %end;
-  %mend; %x()
-  %webout(CLOSE)
-;;;;
-%mm_createwebservice(path=/Public/app/common,name=sendArr)
-```
+## Testing
 
-# Viya
-```
-filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/mc_all.sas";
-%inc mc;
+This repository contains a suite of tests built using [@sasjs/test-framework](https://github.com/sasjs/test-framework).
 
-filename ft15f001 temp;
-parmcards4;
-  %webout(OPEN)
-  %global sasjs_tables;
-  %let sasjs_tables=&sasjs_tables;
-  %put &=sasjs_tables;
-  %let sasjs_tables=&sasjs_tables;
-  %macro x();
-  %global sasjs_tables;
-  %do i=1 %to %sysfunc(countw(&sasjs_tables));
-    %let table=%scan(&sasjs_tables,&i);
-    %webout(OBJ,&table)
-  %end;
-  %mend;
-  %x()
-  %webout(CLOSE)
-;;;;
-%mv_createwebservice(path=/Public/app/common,name=sendObj)
-filename ft15f001 temp;
-parmcards4;
-  %webout(OPEN)
-  %global sasjs_tables;
-  %let sasjs_tables=&sasjs_tables;
-  %put &=sasjs_tables;
-  %macro x();
-  %do i=1 %to %sysfunc(countw(&sasjs_tables));
-    %let table=%scan(&sasjs_tables,&i);
-    %webout(ARR,&table)
-  %end;
-  %mend;
-  %x()
-  %webout(CLOSE)
-;;;;
-%mv_createwebservice(path=/Public/app/common,name=sendArr)
-```
+Detailed instructions for creating and running the tests can be found [here](https://github.com/sasjs/adapter/blob/master/sasjs-tests/README.md).
 
-The above services will return anything you send.  To run the tests simply launch `npm run cypress`.
+If you'd like to test your changes in an app that uses the adapter, you can do so as follows:
+
+1. Run `npm run package:lib` from the root folder in this repository.
+   This creates a tarball in the `/build` folder.
+2. In your app's root folder, run `npm install <path/to/tarball>`.
+   This will install the changed version of the adapter in your app.

README.md

@@ -1,6 +1,6 @@
 [![](https://data.jsdelivr.com/v1/package/npm/@sasjs/adapter/badge)](https://www.jsdelivr.com/package/npm/@sasjs/adapter)
 
-# SASjs
+# @sasjs/adapter
 
 SASjs is a open-source framework for building Web Apps on SAS® platforms. You can use as much or as little of it as you like. This repository contains the JS adapter, the part that handles the to/from SAS communication on the client side. There are 3 ways to install it:
 
@@ -10,21 +10,20 @@ SASjs is a open-source framework for building Web Apps on SAS® platforms. You c
 
 3 - Reference directly from the CDN - in which case click [here](https://www.jsdelivr.com/package/npm/@sasjs/adapter?tab=collection) and select "SRI" to get the script tag with the integrity hash.
 
-If you are short on time and just need to build an app quickly, then check out [this video](https://vimeo.com/393161794) and the [react-seed-app](https://github.com/macropeople/react-seed-app) which provides some boilerplate.
+If you are short on time and just need to build an app quickly, then check out [this video](https://vimeo.com/393161794) and the [react-seed-app](https://github.com/sasjs/react-seed-app) which provides some boilerplate.
 
 For more information on building web apps with SAS, check out [sasjs.io](https://sasjs.io)
 
 ## None of this makes sense. How do I build an app with it?
 
-Ok ok. Deploy this [example.html](https://github.com/sasjs/adapter/blob/master/example.html) file to your web server, and update `servertype` to `SAS9` or `SASVIYA` depending on your backend.
+Ok ok. Deploy this [example.html](https://raw.githubusercontent.com/sasjs/adapter/master/example.html) file to your web server, and update `servertype` to `SAS9` or `SASVIYA` depending on your backend.
 
 The backend part can be deployed as follows:
 
 ```
-%let appLoc=/Public/app/readme;  /* Metadata or Viya Folder location as per SASjs config */
-/* compile macros (can also be downloaded & compiled seperately) */
-filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/mc_all.sas";
-%inc mc;
+%let appLoc=/Public/app/readme;  /* Metadata or Viya Folder per SASjs config */
+filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
+%inc mc; /* compile macros (can also be downloaded & compiled seperately) */
 filename ft15f001 temp;
 parmcards4;
   %webout(FETCH) /* receive all data as SAS datasets */
@@ -44,6 +43,6 @@ You now have a simple web app with a backend service!
 
 # More resources
 
-For more information specific to this adapter you can check out this [user guide](https://sasjs.io/sasjs/sasjs-adapter/) or the [technical](http://adapter.sasjs.io/) documentation.
+For more information and examples specific to this adapter you can check out the [user guide](https://sasjs.io/sasjs-adapter/) or the [technical](http://adapter.sasjs.io/) documentation.
 
 For more information on building web apps in general, check out these [resources](https://sasjs.io/training/resources/) or contact the [author](https://www.linkedin.com/in/allanbowe/) directly.

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal