update namespaces to codeb

Author: mohanrajpac

README.md

@@ -10,15 +10,15 @@ WordPress Feature flags plugin allow developers to configure features in plugins
 
 ### PHP filters
 
-#### `mr_feature_flags_max_allowed`
+#### `codeb_feature_flags_max_allowed`
 
 Filter to define the maximum number of allowed flags. It is recommended to keep this to default value, which is 20.
 
 Example usage:
 
 ```php
 add_filter(
-	'mr_feature_flags_max_allowed',
+	'codeb_feature_flags_max_allowed',
 	static function () {
 		return 10;
 	}
@@ -27,16 +27,20 @@ add_filter(
 
 ### JS filters
 
-##### `mrFeatureFlags.newFlag.defaultStatus`
+##### `codebFeatureFlags.newFlag.defaultStatus`
 
 The filter controls whether the new flag is enabled by default or not. Default `true`
 
 Example usage:
 
 ```js
-addFilter('mrFeatureFlags.newFlag.defaultStatus', 'codeb-feature-flags', () => {
-	return false;
-});
+addFilter(
+	'codebFeatureFlags.newFlag.defaultStatus',
+	'codeb-feature-flags',
+	() => {
+		return false;
+	}
+);
 ```
 
 ## Development setup
@@ -51,27 +55,33 @@ JS setup
 
 -   `yarn install`
 -   `yarn build` to create the build
--   `yarn start` to start the development watch mode
+-   `yarn start` to start the watch mode
+
+### wp-env
+
+This plugin uses `wp-env` setup to for local environment.
+
+-   `wp-env start` to start the containers
+-   `wp-env stop` to stop the containers
+
+More details on how to access local environment can be found [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#quick-tldr-instructions).
 
 ## Linting and formatting
 
 PHP
 
 -   `composer lint`
--   To auto fix the linting errors `composer lint:fix`
-
-💡 [VSCode extension](https://marketplace.visualstudio.com/items?itemName=shevaua.phpcs) to auto format PHP files based on `phpcs.xml.dist` configuration
+-   `composer lint:fix` to auto fix PHP linting errors.
 
 JS
 
 -   `yarn lint:js`
-
-💡 [VSCode extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to auto format JS / TS files based on `.prettierrc.js` configuration
+-   `yarn lint:js:fix` to auto fix JS linting errors.
 
 CSS
 
 -   `yarn lint:css`
--   To auto fix the css linting errors `yarn lint:css:fix`
+-   `yarn lint:css:fix` to auto fix CSS linting errors.
 
 ## Testing
 
@@ -85,10 +95,10 @@ CSS
 
 ### JS
 
--   Run `yarn test:js` which will run all jest and React Testing Library tests
+-   Run `yarn test:js` to run all Jest and React Testing Library tests
 
 ### E2E
 
 The E2E tests depends on `wp-env` setup. Ensure you run `wp-env start` before running the tests.
 
--   Run `yarn test:e2e` which will run all Playwright e2e tests.
+-   Run `yarn test:e2e` to run all Playwright e2e tests.

includes/Api/Flags.php

@@ -13,6 +13,7 @@
 use WP_Error;
 use WP_REST_Server;
 use WP_REST_Request;
+use CodeB\FeatureFlags\Flag;
 
 /**
  * Class Settings
@@ -22,13 +23,6 @@
  */
 class Flags {
 
-	/**
-	 * Name in options table.
-	 *
-	 * @var string $option_name
-	 */
-	public static $option_name = 'mr_feature_flags';
-
 	/**
 	 * Maximum allowed flags.
 	 *
@@ -83,7 +77,7 @@ public function register_routes(): void {
 	 * @return mixed List of flags.
 	 */
 	public function get_all_flags() {
-		$flags = get_option( self::$option_name, [] );
+		$flags = get_option( Flag::$option_name, [] );
 		return rest_ensure_response( $flags );
 	}
 
@@ -102,14 +96,14 @@ public function post_flags( WP_REST_Request $request ) {
 			/**
 			 * Filter to update max allowed feature flags.
 			 */
-			$max_allowed_flags = apply_filters( 'mr_feature_flags_max_allowed', self::$max_flags );
+			$max_allowed_flags = apply_filters( 'codeb_feature_flags_max_allowed', self::$max_flags );
 			if ( count( $input_data['flags'] ) > $max_allowed_flags ) {
 				// translators: %d is a placeholder for the maximum allowed flags.
 				$error_message = sprintf( __( 'Cannot add more than %d flags', 'codeb-feature-flags' ), $max_allowed_flags );
 				return new WP_Error( 'flag_limit_exceeded', $error_message, array( 'status' => 400 ) );
 			}
 
-			update_option( self::$option_name, $input_data['flags'] );
+			update_option( Flag::$option_name, $input_data['flags'] );
 			return rest_ensure_response(
 				array(
 					'status'  => 200,

includes/Flag.php

@@ -23,7 +23,7 @@ class Flag {
 	 *
 	 * @var string $option_name
 	 */
-	public static $option_name = 'mr_feature_flags';
+	public static $option_name = 'codeb_feature_flags';
 
 
 	/**

includes/Helper.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * This is the init file for the plugin
+ * Helper class
  *
  * @package codeb-feature-flags
  * @since 0.1.0
@@ -11,7 +11,7 @@
 namespace CodeB\FeatureFlags;
 
 /**
- * Class FeatureFlags
+ * Class Helper
  *
  * @package codeb-feature-flags
  * @since 0.1.0

includes/Settings.php

@@ -52,6 +52,6 @@ public function register_settings() {
 	 * @return void
 	 */
 	public function render_page(): void {
-		echo '<div id="mr_feature_flags_settings_screen"></div>';
+		echo '<div id="codeb_feature_flags_settings_screen"></div>';
 	}
 }

package.json

@@ -6,6 +6,7 @@
 		"start": "wp-scripts start",
 		"build": "wp-scripts build",
 		"lint:js": "wp-scripts lint-js",
+		"lint:js:fix": "wp-scripts lint-js --fix",
 		"lint:css": "wp-scripts lint-style",
 		"lint:css:fix": "npm run lint:css -- --fix",
 		"test:js": "wp-scripts test-unit-js",

playwright.config.ts

@@ -12,7 +12,7 @@ export default defineConfig({
 	fullyParallel: true,
 	forbidOnly: !!process.env.CI,
 	retries: process.env.CI ? 2 : 0,
-	workers: 4,
+	workers: process.env.CI ? 4 : 1,
 	reporter: 'html',
 	use: {
 		baseURL: process.env.WP_BASE_URL,

plugin.php

@@ -33,7 +33,7 @@
 /**
  * API and Plugin version constants.
  */
-define( 'MR_FEATURE_FLAGS_PLUGIN_PATH', __FILE__ );
+define( 'CODEB_FEATURE_FLAGS_PLUGIN_PATH', __FILE__ );
 
 if ( ! file_exists( Flag::class ) ) {
 	include_once __DIR__ . '/vendor/autoload.php';
@@ -44,7 +44,7 @@
 	'admin_enqueue_scripts',
 	static function ( string $page ): void {
 		if ( 'toplevel_page_codeb-feature-flags' === $page ) {
-			mr_feature_flags_load_settings_scripts();
+			codeb_feature_flags_load_settings_scripts();
 		}
 	}
 );
@@ -54,10 +54,10 @@ static function ( string $page ): void {
  *
  * @return void
  */
-function mr_feature_flags_load_settings_scripts(): void {
+function codeb_feature_flags_load_settings_scripts(): void {
 
-	$plugin_url          = plugin_dir_url( MR_FEATURE_FLAGS_PLUGIN_PATH );
-	$settings_asset_file = require_once plugin_dir_path( MR_FEATURE_FLAGS_PLUGIN_PATH ) . 'build/settings.asset.php'; // @phpcs:ignore
+	$plugin_url          = plugin_dir_url( CODEB_FEATURE_FLAGS_PLUGIN_PATH );
+	$settings_asset_file = require_once plugin_dir_path( CODEB_FEATURE_FLAGS_PLUGIN_PATH ) . 'build/settings.asset.php'; // @phpcs:ignore
 
 	wp_enqueue_script(
 		'codeb-feature-flags',
@@ -80,21 +80,21 @@ function mr_feature_flags_load_settings_scripts(): void {
 // Enqueue scripts and styles for front end.
 add_action(
 	'wp_enqueue_scripts',
-	__NAMESPACE__ . '\mr_feature_flags_scripts_enqueue'
+	__NAMESPACE__ . '\codeb_feature_flags_scripts_enqueue'
 );
 
 // Enqueue scripts and styles for wp-admin.
 add_action(
 	'admin_enqueue_scripts',
-	__NAMESPACE__ . '\mr_feature_flags_scripts_enqueue'
+	__NAMESPACE__ . '\codeb_feature_flags_scripts_enqueue'
 );
 
 /**
  * Enqueue scripts and assets for admin and front end
  */
-function mr_feature_flags_scripts_enqueue(): void {
-	$plugin_url        = plugin_dir_url( MR_FEATURE_FLAGS_PLUGIN_PATH );
-	$script_asset_file = include_once plugin_dir_path( MR_FEATURE_FLAGS_PLUGIN_PATH ) . 'build/index.asset.php';
+function codeb_feature_flags_scripts_enqueue(): void {
+	$plugin_url        = plugin_dir_url( CODEB_FEATURE_FLAGS_PLUGIN_PATH );
+	$script_asset_file = include_once plugin_dir_path( CODEB_FEATURE_FLAGS_PLUGIN_PATH ) . 'build/index.asset.php';
 
 	wp_enqueue_script(
 		'codeb-feature-flags-script',
@@ -114,20 +114,20 @@ function mr_feature_flags_scripts_enqueue(): void {
 
 	wp_localize_script(
 		'codeb-feature-flags-script',
-		'mrFeatureFlags',
+		'codebFeatureFlags',
 		[
 			'flags' => $flags_list,
 		]
 	);
 }
 
 // Registers feature flags admin setting page.
-$mr_feature_flags_admin_settings = new Settings();
-$mr_feature_flags_admin_settings->register_feature_settings();
+$codeb_feature_flags_admin_settings = new Settings();
+$codeb_feature_flags_admin_settings->register_feature_settings();
 
 // Registers feature flags API's.
-$mr_feature_flags_register_api = new Flags();
-$mr_feature_flags_register_api->register();
+$codeb_feature_flags_register_api = new Flags();
+$codeb_feature_flags_register_api->register();
 
 
 // Displays setting page link in plugin page.
@@ -152,13 +152,13 @@ static function ( $links ) {
 	}
 );
 
-register_deactivation_hook( __FILE__, __NAMESPACE__ . '\mr_feature_flags_uninstall' );
+register_deactivation_hook( __FILE__, __NAMESPACE__ . '\codeb_feature_flags_uninstall' );
 
 /**
  * Uninstall method for the plugin.
  * 
  * @return void
  */
-function mr_feature_flags_uninstall(): void {
+function codeb_feature_flags_uninstall(): void {
 	delete_option( Flag::$option_name );
 }

src/components/Flags.tsx

@@ -81,7 +81,7 @@ const Layout = (): JSX.Element => {
 	return (
 		<>
 			<div id="mr-feature-flag-layout">
-				<h1>{__('Feature Flags settings', 'codeb-feature-flags')}</h1>
+				<h1>{__('Feature Flags', 'codeb-feature-flags')}</h1>
 				<div id="mr-feature-flag-content">
 					{lastFlag ? <Header /> : ''}
 					{isLoading ? (

src/components/SubmitControls.tsx

@@ -23,7 +23,7 @@ const SubmitControls = ({
 }: SubmitControlsProps): JSX.Element => {
 	const handleNewFlag = () => {
 		const defaultStatus = applyFilters(
-			'mrFeatureFlags.newFlag.defaultStatus',
+			'codebFeatureFlags.newFlag.defaultStatus',
 			true
 		) as boolean;
 		const newFlag = {