Add linter and code formatter (#8)

.github/workflows/ci-as-lint.yml

@@ -0,0 +1,52 @@
+name: ci-as-lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+jobs:
+  get-dirs:
+    name: Get Directories
+    runs-on: ubuntu-latest
+    outputs:
+      dirs: ${{ steps.get-dirs.outputs.dirs }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Get subdirectories
+        id: get-dirs
+        # we need to lint the src directory and all the examples
+        run: echo "dirs=$(ls -d examples/*/ | jq -Rsc '["src/"] + split("\n")[:-1]' )" >> ${GITHUB_OUTPUT}
+
+  as-lint:
+    needs: get-dirs
+    if: github.event_name == 'pull_request'
+    name: Lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        dir: ${{ fromJson(needs.get-dirs.outputs.dirs) }}
+    defaults:
+      run:
+        working-directory: ${{ matrix.dir }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ">=20"
+      - name: Check Node and NPM versions
+        run: |
+          node --version
+          npm --version
+      - name: Install dependencies
+        run: npm install
+      - name: Validate code is formatted
+        run: npm run pretty:check
+      - name: Valid code is linted
+        run: npm run lint

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "editor.formatOnSave": true,
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[graphql]": {
+        "editor.formatOnSave": false
+    }
+}

examples/hmplugin1/.eslintrc.json

@@ -0,0 +1,13 @@
+{
+  "env": {
+    "es6": true
+  },
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {}
+}

examples/hmplugin1/.prettierignore

@@ -0,0 +1,2 @@
+# don't run prettier on graphql files, because it places every directive on a new line
+*.graphql

examples/hmplugin1/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["assemblyscript-prettier"]
+}

examples/hmplugin1/README.md

@@ -46,7 +46,7 @@ Try some graphql queries on the Dgraph endpoint:
 
 ```graphql
 {
-  getFullName(firstName: "John", lastName:"Doe")
+  getFullName(firstName: "John", lastName: "Doe")
 }
 ```
 
@@ -55,13 +55,14 @@ These will invoke the respective Hypermode functions within `hmplugin1`.
 Next, try adding some data:
 
 ```graphql
-
 mutation {
-  addPerson(input: [
-    { firstName: "Harry", lastName: "Potter" },
-    { firstName: "Tom", lastName: "Riddle" },
-    { firstName: "Albus", lastName: "Dumbledore" }
-    ]) {
+  addPerson(
+    input: [
+      { firstName: "Harry", lastName: "Potter" }
+      { firstName: "Tom", lastName: "Riddle" }
+      { firstName: "Albus", lastName: "Dumbledore" }
+    ]
+  ) {
     person {
       id
       firstName

examples/hmplugin1/assembly/index.ts

@@ -11,11 +11,11 @@ export function getFullName(firstName: string, lastName: string): string {
 
 export function getPeople(): string {
   const people = [
-    <Person> {firstName: "Bob", lastName: "Smith"},
-    <Person> {firstName: "Alice", lastName: "Jones"}
+    <Person>{ firstName: "Bob", lastName: "Smith" },
+    <Person>{ firstName: "Alice", lastName: "Jones" },
   ];
 
-  people.forEach(p => p.updateFullName());
+  people.forEach((p) => p.updateFullName());
   return JSON.stringify(people);
 }
 
@@ -32,7 +32,7 @@ export function queryPeople1(): string {
 
   const response = dql.query<PeopleData>(query);
   const people = response.data.people;
-  people.forEach(p => p.updateFullName());
+  people.forEach((p) => p.updateFullName());
   return JSON.stringify(people);
 }
 
@@ -47,7 +47,7 @@ export function queryPeople2(): string {
       }
     }
   `;
-  
+
   const results = graphql.execute<PeopleData>(statement);
 
   // completely optional, but let's log some tracing info
@@ -87,7 +87,7 @@ export function newPerson2(firstName: string, lastName: string): string {
   `;
 
   const response = graphql.execute<AddPersonPayload>(statement);
-  return response.data.addPerson.people[0].id!; 
+  return response.data.addPerson.people[0].id!;
 }
 
 function getPersonCount(): i32 {
@@ -105,7 +105,7 @@ function getPersonCount(): i32 {
 
 export function getRandomPerson(): string {
   const count = getPersonCount();
-  const offset = <u32> Math.floor(Math.random() * count);
+  const offset = <u32>Math.floor(Math.random() * count);
   const statement = `
     query {
       people: queryPerson(first: 1, offset: ${offset}) {
@@ -116,11 +116,12 @@ export function getRandomPerson(): string {
       }
     }
   `;
-  
+
   const results = graphql.execute<PeopleData>(statement);
   return JSON.stringify(results.data.people[0]);
 }
 
+
 @json
 class Person {
   id: string | null = null;
@@ -133,21 +134,25 @@ class Person {
   }
 }
 
+
 @json
 class PeopleData {
   people!: Person[];
 }
 
+
 @json
 class AddPersonPayload {
   addPerson!: PeopleData;
 }
 
+
 @json
 class AggregatePersonResult {
   aggregatePerson!: GQLAggregateValues;
 }
 
+
 @json
 class GQLAggregateValues {
   count: u32 = 0;

examples/hmplugin1/assembly/tsconfig.json

@@ -1,6 +1,4 @@
 {
   "extends": "assemblyscript/std/assembly.json",
-  "include": [
-    "./**/*.ts"
-  ]
+  "include": ["./**/*.ts"],
 }