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

Update list package #3

Open
wants to merge 48 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
80bdf08
Create the correct element or ordered lists
eduPHP Aug 24, 2020
e901d43
upd branch, improve tag creation, support block settings
neSpecc Nov 6, 2020
7fef622
Merge pull request #47 from swalker2/patch-1
neSpecc Nov 6, 2020
b610646
Remove legacy method "::set-env"
talyguryn Nov 17, 2020
7edbf78
Remove bundle
talyguryn Nov 17, 2020
6c1d2eb
Ignore dist directory
talyguryn Nov 17, 2020
309b473
Merge pull request #52 from editor-js/talyguryn-patch-1
talyguryn Nov 18, 2020
ebc4089
Bump ini from 1.3.5 to 1.3.7
dependabot[bot] Dec 11, 2020
893d678
Fix focus to next block
hata6502 Jan 22, 2021
2f67e12
Merge pull request #56 from hata6502/master
neSpecc Jan 26, 2021
8d036f9
Bump elliptic from 6.5.2 to 6.5.4
dependabot[bot] Mar 9, 2021
059ef65
Merge pull request #53 from editor-js/dependabot/npm_and_yarn/ini-1.3.7
talyguryn Mar 24, 2021
cce71dc
Merge pull request #59 from editor-js/dependabot/npm_and_yarn/ellipti…
talyguryn Mar 24, 2021
6148284
Add config for default list style
Nov 7, 2020
5d3fc52
build
Nov 9, 2020
d799434
Bump y18n from 4.0.0 to 4.0.1
dependabot[bot] Mar 30, 2021
d92deb7
Bump ssri from 6.0.1 to 6.0.2
dependabot[bot] Apr 19, 2021
cf89f3b
Bump lodash from 4.17.15 to 4.17.21
dependabot[bot] May 8, 2021
d2c23fe
Bump browserslist from 4.12.0 to 4.16.6
dependabot[bot] May 25, 2021
3f04c05
Bump path-parse from 1.0.6 to 1.0.7
dependabot[bot] Aug 10, 2021
c122c70
Merge pull request #68 from editor-js/dependabot/npm_and_yarn/path-pa…
talyguryn Nov 25, 2021
69eed4b
Merge pull request #64 from editor-js/dependabot/npm_and_yarn/lodash-…
talyguryn Nov 25, 2021
b1511ee
Merge pull request #60 from editor-js/dependabot/npm_and_yarn/y18n-4.0.1
talyguryn Nov 25, 2021
d2216f1
Merge pull request #61 from editor-js/dependabot/npm_and_yarn/ssri-6.0.2
talyguryn Nov 25, 2021
004a064
Merge pull request #66 from editor-js/dependabot/npm_and_yarn/browser…
talyguryn Nov 25, 2021
d9c77b2
Update package.json
robonetphy Mar 9, 2022
58b5dc7
Merge pull request #51 from 0xycvv/default-style
robonetphy Mar 9, 2022
cf81089
Update tunes config and icons
TatianaFomina Nov 14, 2022
1dfbe77
Update version
TatianaFomina Nov 14, 2022
f0e9f01
Merge pull request #76 from editor-js/update-tunes
TatianaFomina Nov 29, 2022
1b30742
the vite added
robonetphy Nov 8, 2023
8207020
remove webpack add post config
robonetphy Nov 8, 2023
2715a6e
configure with vite
robonetphy Nov 8, 2023
60e95b7
update the version
robonetphy Nov 8, 2023
0401250
readme updated
robonetphy Nov 9, 2023
2e47571
update the readme
robonetphy Nov 9, 2023
4b4ecc6
update the readme
robonetphy Nov 9, 2023
1500864
Merge pull request #89 from editor-js/migrate/vite
robonetphy Nov 10, 2023
8e7fd38
Update npm-publish.yml
GoldenJaden Nov 13, 2023
a6dc6a6
Merge pull request #91 from GoldenJaden/Move-npm-publish-to-common-wo…
GoldenJaden Nov 18, 2023
01426e9
jsdoc types processing added, refs #88.
Sozialarchiv Jul 18, 2024
bfa3e38
Update yarn.lock
Sozialarchiv Jul 22, 2024
e01ebef
types at root level in package.json added
Sozialarchiv Jul 22, 2024
5c4084e
Version to 1.10.0 updated
Sozialarchiv Jul 22, 2024
2977364
Merge pull request #97 from Sozialarchiv/master
neSpecc Jul 24, 2024
9abdba5
Update README.md
e11sy Nov 13, 2024
3dd5b86
Update README.md
e11sy Nov 13, 2024
3812544
Merge pull request #99 from editor-js/update-readme
neSpecc Nov 13, 2024
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: 5 additions & 23 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,8 @@ on:
- master

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12
registry-url: https://registry.npmjs.org/
- run: yarn
- run: yarn build
- run: yarn publish --access=public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
notify:
needs: publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: echo ::set-env name=EMOJI_PACKAGE::$'\xf0\x9f\x93\xa6'
- run: echo ::set-env name=PACKAGE_NAME::$(node -p "require('./package.json').name")
- run: echo ::set-env name=PACKAGE_VERSION::$(node -p "require('./package.json').version")
- run: echo ::set-env name=MESSAGE::"$EMOJI_PACKAGE [$PACKAGE_NAME](https://npmjs.com/package/$PACKAGE_NAME) $PACKAGE_VERSION was published"
- run: curl -X POST ${{ secrets.CODEX_BOT_NOTIFY_EDITORJS_PUBLIC_CHAT }} -d "message=$MESSAGE" -d parse_mode=Markdown -d disable_web_page_preview=true
publish-and-notify:
uses: codex-team/github-workflows/.github/workflows/npm-publish-and-notify-reusable.yml@main
secrets:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
CODEX_BOT_NOTIFY_EDITORJS_PUBLIC_CHAT: ${{ secrets.CODEX_BOT_NOTIFY_EDITORJS_PUBLIC_CHAT }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ node_modules/*
npm-debug.log
.idea/
.DS_Store
dist
3 changes: 2 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.idea/
assets/
src/
webpack.config.js
vite.config.js
postcss.config.js
yarn.lock
34 changes: 11 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,19 @@ This Tool for the [Editor.js](https://editorjs.io) allows you to add ordered or

## Installation

### Install via NPM

Get the package

```shell
npm i --save @editorjs/list
```
```shell
yarn add @editorjs/list
```

Include module at your application

```javascript
import List from '@editorjs/list';
import List from "@editorjs/list";
```

### Download to your project's source dir

1. Upload folder `dist` from repository
2. Add `dist/bundle.js` file to your page.

### Load from CDN

Load the script from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/@editorjs/list) and connect to your page.

```html
<script src="https://cdn.jsdelivr.net/npm/@editorjs/list@latest"></script>
```
Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/list@latest)

## Usage

Expand All @@ -53,14 +37,19 @@ var editor = EditorJS({
list: {
class: List,
inlineToolbar: true,
config: {
defaultStyle: 'unordered'
}
Comment on lines +42 to +44
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistency in default style documentation.

There's a discrepancy between the usage example showing 'unordered' as the value and the config params table indicating that 'ordered' is the default value. Please ensure consistency across the documentation.

},
},
});
```

## Config Params

This Tool has no config params
| Field | Type | Description |
| ------------ | -------- | -------------------------------------------------------------- |
| defaultStyle | `string` | type of a list: `ordered` or `unordered`, default is `ordered` |

## Tool's settings

Expand All @@ -70,11 +59,10 @@ You can choose list`s type.

## Output data

| Field | Type | Description |
| ----- | ---------- | -------------------------------------- |
| Field | Type | Description |
| ----- | ---------- | ---------------------------------------- |
| style | `string` | type of a list: `ordered` or `unordered` |
| items | `string[]` | the array of list's items |

| items | `string[]` | the array of list's items |

```json
{
Expand Down
1 change: 0 additions & 1 deletion dist/bundle.js

This file was deleted.

36 changes: 23 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,35 +1,45 @@
{
"name": "@editorjs/list",
"version": "1.6.0",
"version": "1.10.0",
"keywords": [
"codex editor",
"list",
"tool",
"editor.js",
"editorjs"
],
"description": "List Tool for Editor.js",
"license": "MIT",
"repository": "https://github.com/editor-js/list",
"main": "./dist/bundle.js",
"files": [
"dist"
],
"main": "./dist/list.umd.js",
"module": "./dist/list.mjs",
"types": "./dist/index.d.ts",
"exports": {
".": {
"import": "./dist/list.mjs",
"require": "./dist/list.umd.js",
"types": "./dist/index.d.ts"
}
},
"scripts": {
"build": "webpack --mode production",
"build:dev": "webpack --mode development --watch"
"dev": "vite",
"build": "vite build"
},
"author": {
"name": "CodeX",
"email": "[email protected]"
},
"devDependencies": {
"@babel/core": "^7.10.2",
"@babel/preset-env": "^7.10.2",
"babel-loader": "^8.1.0",
"css-loader": "^3.5.3",
"postcss-loader": "^3.0.0",
"postcss-nested": "^4.2.1",
"postcss-nested-ancestors": "^2.0.0",
"style-loader": "^1.2.1",
"webpack": "^4.43.0",
"webpack-cli": "^3.3.11"
"typescript": "^5.5.3",
"vite": "^4.5.0",
"vite-plugin-css-injected-by-js": "^3.3.0",
"vite-plugin-dts": "^3.9.1"
},
"dependencies": {
"@codexteam/icons": "^0.0.4"
}
}
6 changes: 6 additions & 0 deletions postcss.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
plugins: [
require('postcss-nested-ancestors'),
require('postcss-nested'),
],
};
Loading