Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move repository from yarn to npm #309

Merged
merged 6 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -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'],
},
],
};
10 changes: 5 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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()
4 changes: 2 additions & 2 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions README.md
matthiaslehnertum marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/source/dev/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions docs/source/user/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
*******
Expand Down
Loading
Loading