Move repository from yarn to npm (#309)

* Move repository from yarn to npm

* Update packages

* Remove remaining tslint references

* Update formatting

* Remove issues in package.json

* Update README

Author: matthiaslehnertum

.eslintrc.js

@@ -0,0 +1,28 @@
+/* eslint-env node */
+module.exports = {
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  root: true,
+  rules: {
+    'no-constant-condition': 'off',
+    'no-empty': 'off',
+    'no-extra-boolean-cast': 'off',
+    'no-prototype-builtins': 'off',
+    'no-useless-escape': 'off',
+    'prefer-const': 'off',
+    'no-case-declarations': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/no-this-alias': 'off',
+    '@typescript-eslint/no-unsafe-declaration-merging': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+    },
+  ],
+};

.github/workflows/build.yml

@@ -24,23 +24,23 @@ jobs:
         uses: actions/cache@v2
         with:
           path: node_modules
-          key: ${{ runner.os }}-node_modules-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-node_modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node_modules-
       # see prepare script
       - name: Install Dependencies and Build Library
-        run: yarn install
+        run: npm install
       - name: TypeScript Tests
-        run: yarn test:coverage --ci
+        run: npm run test:coverage --ci
       - name: "Codacy: Report coverage"
         uses: codacy/codacy-coverage-reporter-action@master
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           coverage-reports: coverage/lcov.info
         if: (github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name) && (success() || failure())
       - name: TypeScript Formatting
-        run: yarn prettier:check
+        run: npm run prettier:check
         if: success() || failure()
       - name: TypeScript Code Style
-        run: yarn lint
+        run: npm run lint
         if: success() || failure()

.github/workflows/e2e.yml

@@ -13,5 +13,5 @@ jobs:
       - name: Cypress run
         uses: cypress-io/github-action@v4.1.0
         with:
-          build: yarn build
-          start: yarn start
+          build: npm run build
+          start: npm run start

README.md

@@ -74,6 +74,10 @@ Install the `@ls1intum/apollon` npm package using either [yarn](https://yarnpkg.
 yarn add @ls1intum/apollon
 ```
 
+```sh
+npm install @ls1intum/apollon
+```
+
 Import the `ApollonEditor` class, which is the default export of the npm package:
 
 ```js
@@ -112,13 +116,13 @@ cd Apollon
 Install all node dependencies:
 
 ```
-yarn install
+npm install
 ```
 
 Launch the webpack-dev-server:
 
 ```
-yarn start
+npm run start
 ```
 
 The webpack-dev-server is now listening on [http://localhost:8888](http://localhost:8888). If you change a TypeScript file, webpack will automatically compile the code, bundle the application, and refresh the page in your browser.

docs/source/dev/setup.rst

@@ -13,16 +13,16 @@ Install all node dependencies
 
 .. code-block:: shell
 
-    yarn install
+    npm install
 
 Launch the webpack-dev-server:
 
 .. code-block:: shell
 
-    yarn start
+    npm run start
 
 Run the tests:
 
 .. code-block:: shell
 
-    yarn test
+    npm run test

docs/source/user/getting-started.rst

@@ -14,6 +14,10 @@ Install the `@ls1intum/apollon` npm package using either `yarn <https://yarnpkg.
 
     yarn add @ls1intum/apollon
 
+.. code-block:: bash
+
+    npm install @ls1intum/apollon
+
 *******
 Usage
 *******