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

Improve grunt tasks #5

Merged
merged 8 commits into from
Dec 9, 2019
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
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Before opening a new issue, please:
## I have a feature request
Before opening a new issue, please:
* search for duplicate issues to prevent opening a duplicate feature request. If there is already an open existing request, please leave a comment there.
* add as much information as possible. For example: give us a clear explanation of why you think the feature request is something we should consider for the Granular Control for Yoast SEO plugin.
* add as much information as possible. For example: give us a clear explanation of why you think the feature request is something we should consider for the Yoast SEO: Granular Control plugin.

## I want to create a patch
Community made patches, localizations, bug reports and contributions are very welcome and help Yoast SEO remain the #1 SEO plugin for WordPress.
Expand All @@ -48,7 +48,7 @@ Make sure your problem does not exist as a ticket already by searching through [
* Make the changes to your forked repository.
* Ensure you stick to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/) and you properly document any new functions, actions and filters following the [documentation standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/).
* When committing, reference your issue and include a note about the fix.
* Push the changes to your fork and submit a pull request to the 'trunk' branch of the Granular Control for Yoast SEO repository.
* Push the changes to your fork and submit a pull request to the 'trunk' branch of the Yoast SEO: Granular Control repository.

We will review your pull request and merge when everything is in order. We will help you to make sure the code complies with the standards described above.

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
### Technical info
* WordPress version:
* Yoast SEO version:
* Granular Control for Yoast SEO version:
* Yoast SEO: Granular Control version:
<!-- You can check these boxes once you've created the issue. -->
* If relevant, which editor is affected (or editors):
- [ ] Classic Editor
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ about: Create a report to help us improve
#### Used versions
* WordPress version:
* Yoast SEO version:
* Granular Control for Yoast SEO version:
* Yoast SEO: Granular Control version:
* <!-- If relevant -->Gutenberg plugin version:
* <!-- If relevant -->Classic Editor plugin version:
* Relevant plugins in case of a bug:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ about: Suggest an idea for this project

## Describe the solution you'd like

## why you think the feature request is something we should consider for the Granular Control for Yoast SEO plugin?
## why you think the feature request is something we should consider for the Yoast SEO: Granular Control plugin?

## Additional context
10 changes: 4 additions & 6 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
var path = require( "path" );
var loadGruntConfig = require( "load-grunt-config" );
var timeGrunt = require( "time-grunt" );
global.developmentBuild = true;

/* global global, require, process */
module.exports = function( grunt ) {
Expand All @@ -10,8 +9,12 @@ module.exports = function( grunt ) {
const pkg = grunt.file.readJSON( "package.json" );
const pluginVersion = pkg.yoast.pluginVersion;

// Used to switch between development and release builds.
const developmentBuild = ! [ "release", "release:js", "artifact", "deploy:trunk", "deploy:master" ].includes( process.argv[ 2 ] );

// Define project configuration
var project = {
developmentBuild,
andizer marked this conversation as resolved.
Show resolved Hide resolved
pluginVersion: pluginVersion,
pluginSlug: "yoast-seo-granular-control",
pluginMainFile: "yoast-seo-granular-control.php",
Expand Down Expand Up @@ -80,11 +83,6 @@ module.exports = function( grunt ) {
pkg: pkg,
};

// Used to switch between development and release builds
if ( [ "release", "artifact", "deploy:trunk", "deploy:master" ].includes( process.argv[ 2 ] ) ) {
global.developmentBuild = false;
}

// Load Grunt configurations and tasks
loadGruntConfig( grunt, {
configPath: path.join( process.cwd(), "node_modules/@yoast/grunt-plugin-tasks/config/" ),
Expand Down
6 changes: 3 additions & 3 deletions admin/class-admin-page.php
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<?php
/**
* Clicky for WordPress plugin file.
* Yoast SEO: Granular Control for WordPress plugin file.
*
* @package Yoast\Clicky\Admin
* @package Yoast\Yoast_SEO_Granular_Control\Admin
*/

namespace Yoast_SEO_Granular_Control;

/**
* Class for the Clicky plugin admin page.
* Class for the Yoast SEO: Granular Control plugin admin page.
*/
class Admin_Page extends Admin {

Expand Down
4 changes: 2 additions & 2 deletions admin/class-admin.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Admin {
public $hook = 'yoast-seo-granular-control';

/**
* Construct of class Clicky_admin.
* Construct of class Yoast SEO: Granular Control admin.
*
* @access private
* @link https://codex.wordpress.org/Function_Reference/add_action
Expand Down Expand Up @@ -52,7 +52,7 @@ public function admin_init() {
private function register_menu_pages() {
add_submenu_page(
'wpseo_dashboard',
__( 'Yoast SEO Granular Control', 'yoast-seo-granular-control' ),
__( 'Yoast SEO: Granular Control', 'yoast-seo-granular-control' ),
__( 'Granular Control', 'yoast-seo-granular-control' ),
'manage_options',
$this->hook,
Expand Down
6 changes: 3 additions & 3 deletions admin/views/admin-page.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<?php
/**
* Clicky for WordPress plugin file.
* Yoast SEO: Granular Control for WordPress plugin file.
*
* @package Yoast/Clicky/View
* @package Yoast/Yoast_SEO_Granular_Control/View
*/

namespace Yoast_SEO_Granular_Control;

?><div class="wrap">
<h2>
<?php esc_html_e( 'Yoast SEO Granular controls', 'yoast-seo-granular-control' ); ?>
<?php esc_html_e( 'Yoast SEO: Granular Control', 'yoast-seo-granular-control' ); ?>
<?php settings_errors(); ?>
</h2>

Expand Down
5 changes: 3 additions & 2 deletions grunt/config/aliases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
build:
- 'build:css'
- 'build:js'

# Build a distribution zip file
'artifact':
- 'shell:composer-install-production'
Expand All @@ -25,7 +26,7 @@ build:
# Get the project ready for release
# Note that using this command triggers some global variables to be different than if you use simply `build`
release:
- build
- 'build'

# Deploy current state to WordPress.org trunk
'deploy:trunk':
Expand All @@ -46,4 +47,4 @@ release:

# Default task
default:
- build
- 'build'
12 changes: 6 additions & 6 deletions languages/yoast-seo-granular-control.pot
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Copyright (C) 2019 Team Yoast
# This file is distributed under the same license as the Granular Control for Yoast SEO package.
# This file is distributed under the same license as the Yoast SEO: Granular Control package.
msgid ""
msgstr ""
"Project-Id-Version: Granular Control for Yoast SEO 0.1\n"
"Project-Id-Version: Yoast SEO: Granular Control 0.1\n"
"Report-Msgid-Bugs-To: "
"https://github.com/yoast/yoast-seo-granular-control/issues\n"
"POT-Creation-Date: 2019-10-01 12:54:48+00:00\n"
Expand Down Expand Up @@ -46,7 +46,7 @@ msgid "Latest news from Yoast"
msgstr ""

#: admin/class-admin.php:55 artifact/admin/class-admin.php:55
msgid "Yoast SEO Granular Control"
msgid "Yoast SEO: Granular Control"
msgstr ""

#: admin/class-admin.php:56 artifact/admin/class-admin.php:56
Expand Down Expand Up @@ -354,7 +354,7 @@ msgid "Include empty term archives"
msgstr ""

#: admin/views/admin-page.php:12 artifact/admin/views/admin-page.php:12
msgid "Yoast SEO Granular controls"
msgid "Yoast SEO: Granular Control"
msgstr ""

#: admin/views/admin-page.php:23 artifact/admin/views/admin-page.php:23
Expand Down Expand Up @@ -429,7 +429,7 @@ msgid "Register now &raquo;"
msgstr ""

#. Plugin Name of the plugin/theme
msgid "Granular Control for Yoast SEO"
msgid "Yoast SEO: Granular Control"
msgstr ""

#. Plugin URI of the plugin/theme
Expand All @@ -449,4 +449,4 @@ msgstr ""

#. Author URI of the plugin/theme
msgid "https://yoast.com/"
msgstr ""
msgstr ""
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "yoast-seo-granular-control",
"description": "Development files for the Yoast SEO Granular Control plugin",
"description": "Development files for the Yoast SEO: Granular Control plugin",
"plugin": {
"glotpress": "https://translate.yoast.com",
"glotpress_path": "yoast-seo-granular-control",
Expand All @@ -16,7 +16,7 @@
"url": "https://github.com/Yoast/yoast-seo-granular-control"
},
"devDependencies": {
"@yoast/grunt-plugin-tasks": "1.4.2"
"@yoast/grunt-plugin-tasks": "^1.6.0"
},
"yoast": {
"pluginVersion": "1.0"
Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Yoast SEO

## Welcome to the Granular Control for Yoast SEO GitHub repository
## Welcome to the Yoast SEO: Granular Control GitHub repository

## Want to contribute to Granular Control for Yoast SEO?
## Want to contribute to Yoast SEO: Granular Control?

### Prerequisites

Expand All @@ -13,8 +13,8 @@ At Yoast, we make use a specific toolset to develop our code. Please ensure you
* [Grunt](https://gruntjs.com/)

### Getting started
After installing the aforementioned tools, you can use the steps below to acquire a development version of Granular Control for Yoast SEO.
Please note that this will download the latest development version of Granular Control for Yoast SEO. While this version is usually stable,
After installing the aforementioned tools, you can use the steps below to acquire a development version of Yoast SEO: Granular Control.
Please note that this will download the latest development version of Yoast SEO: Granular Control. While this version is usually stable,
it is not recommended for use in a production environment.

Within your WordPress installation, navigate to `wp-content/plugins` and run the following commands:
Expand Down
8 changes: 4 additions & 4 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== Granular control for Yoast SEO ===
=== Yoast SEO: Granular Control ===
Contributors: yoast, joostdevalk
Tags: yoast, xml sitemaps, schema, seo
Requires at least: 5.0
Expand All @@ -12,7 +12,7 @@ This plugin enables expert users and developers to change advanced settings in Y

== Description ==

Granular Control for Yoast SEO enables expert users and developers to change advanced settings in Yoast SEO, and to alter its defaults. Please take care when using these options; most users won't need to use this plugin, and those who do should take care not to _harm_ their site's SEO.
Yoast SEO: Granular Control enables expert users and developers to change advanced settings in Yoast SEO, and to alter its defaults. Please take care when using these options; most users won't need to use this plugin, and those who do should take care not to _harm_ their site's SEO.

Unfortunately, due to the nature of this plugin’s features, we can't be held responsible nor provide support for any problems with your website, visibility in search engines, drops in rankings or other issues related to your changes. Installing and using this plugin is solely your own responsibility.

Expand Down Expand Up @@ -63,9 +63,9 @@ Unfortunately, due to the nature of this plugin’s features, we can't be held r

== Installation ==

1. Upload the plugin files to the `/wp-content/plugins/granular-control-yoast-seo` directory, or install the plugin through the WordPress plugins screen directly.
1. Upload the plugin files to the `/wp-content/plugins/yoast-seo-granular-control` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' screen in WordPress
1. Use the SEO -> Granular control screen to configure the plugin
1. Use the SEO -> Granular Control screen to configure the plugin

== Changelog ==

Expand Down
Loading