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

feature/0.7.0 - upgrade dependencies #67

Merged
merged 9 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist/
37 changes: 14 additions & 23 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@
"es6": true,
"node": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended"
],
"extends": ["eslint:recommended", "plugin:@typescript-eslint/eslint-recommended", "prettier", "plugin:prettier/recommended"],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
Expand All @@ -17,28 +14,22 @@
"ecmaVersion": 2018,
"sourceType": "module"
},
"plugins": [
"@typescript-eslint"
],
"plugins": ["@typescript-eslint"],
"rules": {
"no-console": ["error", { "allow": ["warn"] }],
"no-unused-vars": 0,
"@typescript-eslint/no-unused-vars": "error",
"indent": [
"error",
2
],
"linebreak-style": [
"prettier/prettier": ["error"],
"no-console": [
"error",
"unix"
{
"allow": ["warn"]
}
],
"quotes": [
"error",
"single"
],
"semi": [
"no-unused-vars": 0,
"@typescript-eslint/no-unused-vars": [
"error",
"never"
{
"argsIgnorePattern": "^_",
"varsIgnorePattern": "^_"
}
]
}
}
}
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
node_modules/
dist/
.cache/
.vscode
.vscode
.parcel-cache
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dist
docs
package-lock.json
26 changes: 26 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"tabWidth": 2,
"printWidth": 140,
"semi": false,
"useTabs": false,
"singleQuote": true,
"bracketSameLine": true,
"jsxSingleQuote": true,
"endOfLine": "lf",
"trailingComma": "none",
"parser": "typescript",
"overrides": [
{
"files": ["*.json", "*rc"],
"options": { "parser": "json" }
},
{
"files": "*.md",
"options": { "parser": "markdown" }
},
{
"files": "*.html",
"options": { "parser": "html" }
}
]
}
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# Trellis

[![npm version](https://badge.fury.io/js/%40sayari%2Ftrellis.svg)](https://badge.fury.io/js/%40sayari%2Ftrellis)

A highly performant network visualization library with a simple, declarative API, plugable renderers, and bindings for different frameworks and use cases

## Installation

if using npm

```bash
npm install @sayari/trellis
```

or alternatively import via HTML

```html
<script src='https://unpkg.com/@sayari/trellis@{VERSION}/index.umd.min.js'></script>
<script src="https://unpkg.com/@sayari/trellis@{VERSION}/index.umd.min.js"></script>
```

## Examples
Expand All @@ -24,6 +28,7 @@ or alternatively import via HTML
- [React Selection Multiselect Tool](https://codesandbox.io/s/trellis-react-and-selection-example-68dg5?file=/src/Graph.js)

## Modules

- renderers
- WebGL
- png/jpg
Expand All @@ -37,18 +42,23 @@ or alternatively import via HTML
- native

## Philosophy

Trellis decouples graph rendering from graph layout computations, and decouples both from framework-specific bindings. Additionally, the Trellis renderer is mostly stateless, leaving questions of state management to the application and allowing for simple customization of library behavior. This means integrating any of Trellis modules with an existing application should be relatively straightforward. Similar to rendering libraries like React, Trellis focuses on performant rendering and graph-based computations, while remaining agnostic about where and how state is managed. Moreover, by splitting responsibilities into separate modules, if existing modules don't fit your needs, you can always roll your own, while still benefiting from the remaining modules that are helpful.

## See Also

- Sigma js

### Development

```bash
npm run dev
```

### Deployment

prerelease

```bash
npm run build

Expand All @@ -62,6 +72,7 @@ npm publish dist/ --tag next
```

release

```bash
npm run build

Expand Down
Loading
Loading