readme_improvements #73

Merged
linos merged 7 commits from readme_improvements into main 2024-10-29 15:23:36 +01:00
3 changed files with 61 additions and 0 deletions
Showing only changes of commit 5a09997928 - Show all commits

1
.gitignore vendored
View file

@ -2,3 +2,4 @@ vendor/
composer.lock
.phpunit.result.cache
node_modules/
package-lock.json

57
Gruntfile.js Normal file
View file

@ -0,0 +1,57 @@
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
checktextdomain: {
options:{
text_domain: 'activitypub-event-bridge',
keywords: [
'__:1,2d',
'_e:1,2d',
'_x:1,2c,3d',
'esc_html__:1,2d',
'esc_html_e:1,2d',
'esc_html_x:1,2c,3d',
'esc_attr__:1,2d',
'esc_attr_e:1,2d',
'esc_attr_x:1,2c,3d',
'_ex:1,2c,3d',
'_n:1,2,4d',
'_nx:1,2,4c,5d',
'_n_noop:1,2,3d',
'_nx_noop:1,2,3c,4d'
]
},
files: {
src: [
'**/*.php', // Include all files
'!sass/**', // Exclude sass/
'!node_modules/**', // Exclude node_modules/
'!tests/**', // Exclude tests/
'!vendor/**', // Exclude vendor/
'!build/**', // Exclude build/
'!static/**', // Exclude static resources
],
expand: true
}
},
wp_readme_to_markdown: {
target: {
files: {
'README.md': 'readme.txt'
},
},
options: {
pre_convert: function( readme ) {
return readme.replace( /\*\*Note\*\*:/g, "> [!NOTE]\n>" );
}
}
}
});
grunt.loadNpmTasks('grunt-wp-readme-to-markdown');
grunt.loadNpmTasks('grunt-checktextdomain');
// Default task(s).
grunt.registerTask('default', ['wp_readme_to_markdown', 'checktextdomain']);
};

View file

@ -21,6 +21,9 @@
"@wordpress/env": "^10.10.0",
"@wordpress/scripts": "^30.0.2",
"classnames": "^2.3.2",
"grunt": "^1.1.0",
"grunt-checktextdomain": "^1.0.1",
"grunt-wp-i18n": "^1.0.3",
"grunt-wp-readme-to-markdown": "^2.0.1"
}
}