effekt - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

LICENSE.txt

 MIT License
 
-Copyright (c) Ivo Dolenc
+Copyright (c) 2024 Ivo Dolenc
 
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy

package.json

 {
   "name": "effekt",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "author": "Ivo Dolenc",
+  "description": "Universal web animation platform.",
   "license": "MIT",
+  "repository": "ivodolenc/effekt",
+  "homepage": "https://github.com/ivodolenc/effekt",
   "type": "module",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.mjs"
+    },
+    "./easing": {
+      "types": "./dist/types/easing/index.d.ts",
+      "import": "./dist/easing/index.mjs"
+    },
+    "./interaction": {
+      "types": "./dist/types/interaction/index.d.ts",
+      "import": "./dist/interaction/index.mjs"
     }
@@ -17,5 +27,57 @@ },
   ],
-  "publishConfig": {
-    "access": "public"
+  "keywords": [
+    "effekt",
+    "animate",
+    "animations",
+    "web-animations",
+    "interaction",
+    "javascript",
+    "typescript",
+    "universal",
+    "animation",
+    "platform",
+    "engine",
+    "tween"
+  ],
+  "scripts": {
+    "dev": "vite -c .config/vite.config.ts playgrounds/browser",
+    "dev:node": "vite-node -w playgrounds/node/main.ts",
+    "test": "vitest -c test/vitest.config.ts",
+    "test:utils": "vitest -c test/utils/vitest.config.ts",
+    "build": "hyperbundler",
+    "build:play": "vite -c .config/vite.config.js build playgrounds/browser",
+    "preview:play": "vite -c .config/vite.config.js preview playgrounds/browser",
+    "lint": "eslint -c .config/eslint.config.js .",
+    "lint:fix": "eslint -c .config/eslint.config.js --fix .",
+    "format": "prettier --config .config/prettier.config.js --write .",
+    "prepublishOnly": "npm run build"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "peerDependencies": {
+    "@types/node": ">=20.0.0",
+    "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@types/node": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@hypernym/bundler": "^0.9.2",
+    "@hypernym/eslint-config": "^3.0.2",
+    "@hypernym/prettier-config": "^3.0.1",
+    "@hypernym/tsconfig": "^2.0.0",
+    "@types/node": "^20.14.2",
+    "eslint": "^9.4.0",
+    "prettier": "^3.3.1",
+    "typescript": "^5.4.5",
+    "vite": "^5.2.12",
+    "vitest": "^1.6.0"
   }
 }

README.md

@@ -1,1 +0,80 @@
-# effekt
+<p align="center">
+  <img alt="Effekt" src=".assets/cover.gif" />
+</p>
+
+<h1 align="center">Effekt</h1>
+
+<h3 align="center">Universal web animation platform.</h3>
+
+<p align="center">An open-source and framework independent JavaScript library designed for modern devs.</p>
+
+<p align="center">
+  <sub>
+    <a href="https://github.com/ivodolenc/effekt">Repository</a> | <a href="https://www.npmjs.com/package/effekt">Package</a> | <a href="https://github.com/ivodolenc/effekt/releases">Releases</a> | <a href="https://github.com/ivodolenc/effekt/discussions">Discussions</a> | <a href="./docs/README.md">Documentation</a>
+  </sub>
+</p>
+
+<br>
+
+<pre align="center">npm install effekt</pre>
+
+<br>
+
+> [!NOTE]
+>
+> **Effekt** is still in development phase and there is a possibility that the [API](./docs/api.md) will change before the first stable release.
+>
+> Any ideas, [suggestions](https://github.com/ivodolenc/effekt/discussions) and code [contributions](.github/CONTRIBUTING.md) are welcome.
+>
+> If you find an issue or bug, please [report](https://github.com/ivodolenc/effekt/issues/new/choose) it so that the project can be improved.
+
+<br>
+
+<p align="center">
+  <sub>Special Sponsor</sub>
+</p>
+
+<p align="center">
+  <a title="Hypernym Studio" href="https://github.com/hypernym-studio">
+    <img alt="Hypernym Studio" width="244" src=".assets/hypernym-studio_logo.svg">
+  </a>
+</p>
+
+<br>
+
+## Features
+
+- Free & Open-source
+- Lightweight & Powerful
+- Supports ESM, IIFE & UMD
+- Framework independent
+- Written in TypeScript
+- Test-covered codebase
+- Fully tree-shakeable
+- No dependencies
+- Super easy to use
+- API friendly
+
+## Documentation
+
+Everything you need for a quick start.
+
+Read the [docs](./docs/README.md) to learn more.
+
+## Community
+
+Feel free to ask questions or share new ideas.
+
+Use the official [discussions](https://github.com/ivodolenc/effekt/discussions) to get involved.
+
+## Contribution
+
+Check out the quick [guide](.github/CONTRIBUTING.md) for more info.
+
+## License
+
+Developed in 🇭🇷 Croatia.
+
+Released under the [MIT](LICENSE.txt) license.
+
+© Ivo Dolenc

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

134347

increased by9152.55%

Number of package files

18

increased by260%

Lines of code

2819

increased by140850%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

81

increased by3950%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

10

increased byInfinity%

No dependency changes