Changes to support .org

.deployignore

@@ -17,6 +17,5 @@ phpunit.xml
 configure.php
 DOCKER_ENV
 phpunit.xml
-tests
 .phpcs
 Makefile

.gitattributes

@@ -5,13 +5,22 @@
 #
 # Via WPCS.
 #
+/.editorconfig expore-ignore
+/.eslintignore expore-ignore
+/.eslintrc.json expore-ignore
 /.github export-ignore
-/.phpcs.xml export-ignore
+/.npmrc expore-ignore
+/.nvmrc expore-ignore
+/.phpcs expore-ignore
 /.phpcs export-ignore
-/phpunit.xml export-ignore
-/tests export-ignore
+/.phpcs.xml expore-ignore
+/.phpcs.xml export-ignore
+/.phpunit.result.cache expore-ignore
 /configure.php export-ignore
 /Makefile export-ignore
+/phpunit.xml export-ignore
+/tests export-ignore
+/types export-ignore
 
 #
 # Auto detect text files and perform LF normalization.

README.md

@@ -1,8 +1,8 @@
-# WP Command Palette
+# Command Palette Extension
 
 Contributors: alleyinteractive
 
-Tags: alleyinteractive, wp-command-palette
+Tags: command-palette, alleyinteractive, wp-command-palette
 
 Stable tag: 0.1.1
 

readme.txt

@@ -0,0 +1,70 @@
+=== Command Palette Extension ===
+Contributors: alleyinteractive
+Tags: command-palette, alleyinteractive, wp-command-palette
+Stable tag: 0.1.1
+Requires at least: 6.4
+Tested up to: 6.5
+Requires PHP: 8.1
+License: GPL v2 or later
+
+Extend the WordPress Command Palette with all the available admin menu items.
+
+## Installation
+
+You can install the package via Composer or download it from WordPress.org:
+
+```bash
+composer require alleyinteractive/wp-command-palette
+```
+
+## Usage
+
+Activate the plugin in WordPress and use it like so:
+
+![Screenshot of plugin](./assets/screenshot.png)
+
+When activated, the plugin will read all the available WordPress admin menu/bar
+items and allow you to easily search for them in the
+[WordPress Command Palette](https://make.wordpress.org/core/2023/07/17/introducing-the-wordpress-command-palette-api/). You can open the command palette
+by pressing `cmd + k` or `ctrl + k` on Windows. The plugin requires WordPress 6.4 or higher.
+
+At some point in the future Gutenberg
+[will be adding](https://github.com/WordPress/gutenberg/pull/54515)
+site-wide command palette support. This plugin will be updated to support that
+when it is available.
+
+## Testing
+
+Run `npm run lint` to run ESLint against all JavaScript files. Linting will also
+happen when running development or production builds.
+
+Run `composer test` to run tests against the PHP code in the plugin.
+
+## Releasing the Plugin
+
+The plugin uses a [built release workflow](./.github/workflows/built-release.yml)
+to compile and tag releases. Whenever a new version is detected in the root
+`composer.json` file or in the plugin's headers, the workflow will automatically
+build the plugin and tag it with a new version. The built tag will contain all
+the required front-end assets the plugin may require. This works well for
+publishing to WordPress.org or for submodule-ing.
+
+When you are ready to release a new version of the plugin, you can run
+`npm run release` to start the process of setting up a new release.
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Credits
+
+This project is actively maintained by [Alley
+Interactive](https://github.com/alleyinteractive). Like what you see? [Come work
+with us](https://alley.com/careers/).
+
+- [Sean Fisher](https://github.com/srtfisher)
+- [All Contributors](../../contributors)
+
+## License
+
+The GNU General Public License (GPL) license. Please see [License File](LICENSE) for more information.

src/assets.php

@@ -62,7 +62,7 @@ function get_entry_dir_path( string $dir_entry_name, bool $dir = false ): string
 	// The relative path from the plugin root.
 	$asset_build_dir = "/build/{$dir_entry_name}/";
 	// Set the absolute file path from the root directory.
-	$asset_dir_path = WP_COMMAND_PALETTE_DIR . $asset_build_dir;
+	$asset_dir_path = dirname( __DIR__ ) . $asset_build_dir;
 
 	if ( validate_path( $asset_dir_path ) ) {
 		// Negotiate the base path.

wp-command-palette.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Plugin Name: WP Command Palette
+ * Plugin Name: Command Palette Extension
  * Plugin URI: https://github.com/alleyinteractive/wp-command-palette
  * Description: Extend the WordPress Command Palette with all the available admin menu items.
  * Version: 0.1.1
@@ -21,10 +21,5 @@
 	exit;
 }
 
-/**
- * Root directory to this plugin.
- */
-define( 'WP_COMMAND_PALETTE_DIR', __DIR__ );
-
 // Load the plugin's main files.
 require_once __DIR__ . '/src/assets.php';