https://github.com/threadi/downloadlist
Provides a Wordpress-Gutenberg block for capturing a download list with file type specific icons.
https://github.com/threadi/downloadlist
gutenberg-blocks wordpress wordpress-plugin
Last synced: about 2 months ago
JSON representation
Provides a Wordpress-Gutenberg block for capturing a download list with file type specific icons.
- Host: GitHub
- URL: https://github.com/threadi/downloadlist
- Owner: threadi
- Created: 2022-01-08T13:01:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-04-10T22:37:34.000Z (2 months ago)
- Last Synced: 2026-04-11T00:09:49.394Z (2 months ago)
- Topics: gutenberg-blocks, wordpress, wordpress-plugin
- Language: PHP
- Homepage: https://wordpress.org/plugins/download-list-block-with-icons/
- Size: 6.71 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# Download List Block with Icons
This repository is the database for the plugin _Download List Block with Icons_. This provides a Gutenberg block to manage a download list with file type specific icons.
## Usage
After checkout go through the following steps:
1. copy _build/build.properties.dist_ to _build/build.properties_.
2. modify the build/build.properties file - note the comments in the file.
3. execute the command in _build/_: `ant init`
4. after that the plugin can be activated in WordPress
## Test
Run `npm start` to compile the Block Editor-Scripts for tests.
## Release
1. increase the version number in _build/build.properties_.
2. execute the following command in _build/_: `ant build`
3. after that you will finde in the release directory a zip file which could be used in WordPress to install it.
## Translations
I recommend to use [PoEdit](https://poedit.net/) to translate texts for this plugin.
### generate pot-file
Run in main directory:
`wp i18n make-pot . languages/download-list-block-with-icons.pot --exclude=docs,css,src,svn`
### update translation-file
1. Open .po-file of the language in PoEdit.
2. Go to "Translate" > "Update from POT-file".
3. After this the new entries are added to the language-file.
### export translation-file
1. Open .po-file of the language in PoEdit.
2. Go to File > Save.
3. Upload the generated .mo-file and the .po-file to the plugin-folder languages/
### generate json-translation-files
Run in main directory:
`wp i18n make-json languages --no-purge`
OR use ant in build/-directory: `ant json-translations`
## Build blocks
### Requirements
`npm install`
### Run for development
`npm start`
### Run for release
`npm run build`
Hint: will be called by ant-command mentioned above.
## Check for WordPress Coding Standards
### Initialize
`composer install`
### Run
`vendor/bin/phpcs --standard=ruleset.xml .`
### Repair
`vendor/bin/phpcbf --standard=ruleset.xml .`
## Check for WordPress VIP Coding Standards
Hint: this check runs against the VIP-GO-platform which is not our target for this plugin. Many warnings can be ignored.
### Run
`vendor/bin/phpcs --extensions=php --ignore=*/vendor/*,*/node_modules/*,*/block/*,*/svn/*,*/src/* --standard=WordPress-VIP-Go .`
## Check PHP compatibility
`vendor/bin/phpcs -p app --standard=PHPCompatibilityWP`
### Generate documentation
`vendor/bin/wp-documentor parse classes --format=markdown --output=docs/hooks.md --prefix=downloadlist_ --exclude=Section.php --exclude=Tab.php --exclude=Import.php --exclude=Export.php --exclude=Field_Base.php --exclude=Settings.php --exclude=Page.php`
## Check with the plugin "Plugin Check"
This runs the plugin check as the plugin check in the WordPress repository does on every plugin update. It should result in no errors.
Hint: run this not in the development environment, it would also check all dependencies that is unnecessary.
Use a normal WordPress installation with an installed PCP plugin.
`wp plugin check --error-severity=7 --warning-severity=6 --include-low-severity-errors --categories=plugin_repo --format=json --slug=personio-integration-light .`
## PHP Unit tests
### Preparation
Be sure to have run `composer install` or `composer update` before.
Then: `composer test-install`
### Run
`composer test`