Skip to content

Commit

Permalink
Upgrade to sigma v3
Browse files Browse the repository at this point in the history
  • Loading branch information
sim51 committed Apr 3, 2024
1 parent 9f4f510 commit d52b626
Show file tree
Hide file tree
Showing 271 changed files with 37,070 additions and 75,437 deletions.
7 changes: 6 additions & 1 deletion project/.eslintrc → .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,10 @@
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"plugin:react/recommended"
]
],
"ignorePatterns":["*.d.ts"],
"rules": {
"@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
"react/react-in-jsx-scope": "off"
}
}
41 changes: 26 additions & 15 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,48 @@ name: Test
on:
push:
paths:
- "project/**"
- "packages/**"
- ".github/workflows/test.yml"
pull_request:
paths:
- "project/**"
- "packages/**"
- ".github/workflows/test.yml"

jobs:
test:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./project

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- name: Cache node_modules
uses: actions/cache@v3
- uses: actions/setup-node@v4
with:
path: "project/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('project/package-lock.json') }}
node-version: 20

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
- name: Cache node_modules
uses: actions/cache@v4
with:
node-version: 16
path: "node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('package-lock.json') }}

- name: Install
run: npm install

- name: Playwright version
id: playwright-version
run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log(require('./package-lock.json').packages['node_modules/playwright'].version)")" >> $GITHUB_ENV

- name: Cache Playwright binaries
uses: actions/cache@v4
id: playwright-cache
with:
path: "~/.cache/ms-playwright"
key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}

- name: Install Playwright Browsers
run: npx playwright install --with-deps
if: steps.playwright-cache.outputs.cache-hit != 'true'

- name: Build
run: npm run build

Expand All @@ -44,10 +55,10 @@ jobs:

- name: Uploading screenshots on failure
if: steps.test.outcome == 'failure'
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: failure-screenshots
path: project/packages/examples/test/e2e/screenshots/
path: packages/storybook/test-results

- name: Exit signal
if: steps.test.outcome == 'failure'
Expand Down
23 changes: 8 additions & 15 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,25 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Cache node_modules
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}

- name: Project - Install
working-directory: project
- name: Install
run: npm install

- name: Project - Compile
working-directory: project
run: npm run compile

- name: Website - Install
working-directory: website
run: npm install

- name: Website - Build
working-directory: website
- name: Build
run: npm run build

- name: Website
run: npm run website

- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4.2.5
with:
branch: gh-pages # The branch the action should deploy to.
folder: website/build # The folder the action should deploy.
folder: packages/website/build # The folder the action should deploy.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
node_modules/
lib/
build/
dist/
*.current.png
*.diff.png
tsconfig.tsbuildinfo
website/docs/api
packages/website/docs/api
.docusaurus
.rollup.cache
storybook-static
1 change: 1 addition & 0 deletions project/.npmignore → .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ node_modules
docs
examples
demo
dist
test
.editorconfig
.eslintignore
Expand Down
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# Changelog

## Version 4.0.0

### Features

- Upgrade to sigma v3
- Upgrade all project dependencies
- Refacto project structure
- Replace `example` project by a storybook
- Replace E2E framework by playwright, and run it on the storybook
- Using stories in website example
- Fully graph typed API (see [#58](https://github.com/sim51/react-sigma/issues/58)). Component & hooks take generic types for node, edge & graph attributs. Exemple for the load graph hook :
```tsx
const loadGraph = useLoadGraph<{label:string, x:number, y:number}, {label:string, size:number}>();
```

### Breaking changes

- React-sigma doesn't depends anymore to lodash. It was use to make a deep equal on the settings provided to the `SigmaContainer`. Now you have to handle that :

```tsx
// Sigma settings are outside the react lifecycle to avoid the change of its ref at every render
// which triggers a full render of sigma. An other way is to use the `useMemo` hook inside the component.
const sigmaSettings = {
allowInvalidContainer: true,
};

export const Example: FC = () => {
return (
<SigmaContainer settings={sigmaSettings}>
<SampleGraph />
</SigmaContainer>
);
};
```

- The sigma setting `allowInvalidContainer` is no more set per default. You have to pass it to the container (check above).

- When you register events on edges, we don't set the correspondig settings anymore, like `enableEdgeClickEvents` (see [#49](https://github.com/sim51/react-sigma/issues/49)).

## Version 3.4.2

### Fixes
Expand Down
File renamed without changes.
Loading

0 comments on commit d52b626

Please sign in to comment.