Skip to content

A template repository for SPARXSTAR projects: AI-powered tools and WordPress plugin development for SparxStar, AiWA, and language preservation projects. Includes custom code for linguistics, community contribution, and multilingual marketing automation.

License

Notifications You must be signed in to change notification settings

Starisian-Technologies/sparxstar-gluon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

56 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
Untitled-7 (2)

SPARXSTARโ„ข Gluon - WordPressยฎ Plugin Starter

A comprehensive template repository for building modern WordPress plugins that follow Starisian Technologies coding conventions and SPARXSTAR deployment standards.

Features

โœจ Modern PHP Development

  • PHP 8.2+ with PSR-4 autoloading
  • WordPress VIP coding standards
  • PHPStan static analysis (Level 5)
  • PHPCS with WordPress standards
  • Rector for automated refactoring
  • PHPUnit for unit testing

๐ŸŽจ Frontend Tooling

  • ESLint for JavaScript linting
  • Stylelint for CSS linting
  • Terser for JS minification
  • clean-css for CSS minification
  • Automated build pipeline (src/ โ†’ assets/)

๐Ÿงช Comprehensive Testing

  • PHPUnit for PHP unit tests
  • Jest for JavaScript unit tests
  • Playwright for E2E testing
  • Puppeteer for browser automation
  • Accessibility testing with axe-core

๐Ÿš€ CI/CD & Automation

  • GitHub Actions workflows
  • Automated releases with version bumping
  • Security scanning (CodeQL, dependency audits)
  • Accessibility validation
  • Code quality checks
  • Automated asset building

๐Ÿ“ฆ Release Management

  • Automated versioning from Git tags
  • Asset minification and optimization
  • i18n POT file generation
  • Checksum generation (MD5, SHA256)
  • Respects .distignore for clean distributions

Quick Start

  1. Clone and Install
git clone https://github.com/Starisian-Technologies/sparxstar-starter.git your-plugin-name
cd your-plugin-name
composer install
npm install
  1. Build Assets
npm run build
  1. Run Tests
composer run test:php
npm test
  1. Activate in WordPress
  • Copy plugin to WordPress plugins directory
  • Activate through WordPress admin

Documentation

Development Commands

PHP

composer run lint:php          # Check PHP code style
composer run fix:php           # Auto-fix PHP issues
composer run analyze:php       # Run PHPStan analysis
composer run test:php          # Run PHPUnit tests
composer run refactor:php      # Preview Rector changes
composer run refactor:php:fix  # Apply Rector refactoring

JavaScript & CSS

npm run lint              # Lint JS & CSS
npm run lint:js          # Lint JavaScript only
npm run lint:css         # Lint CSS only
npm run format           # Format with Prettier
npm test                 # Run Jest tests
npm run test:e2e         # Run Playwright E2E tests

Building

npm run build            # Build all assets
npm run build:js         # Minify JS (src/js โ†’ assets/js)
npm run build:css        # Minify CSS (src/css โ†’ assets/css)
npm run makepot          # Generate translation file

Project Structure

โ”œโ”€โ”€ src/                      # Source code (scanned by linters)
โ”‚   โ”œโ”€โ”€ js/                  # JavaScript source files
โ”‚   โ”œโ”€โ”€ css/                 # CSS source files
โ”‚   โ”œโ”€โ”€ core/                # Core PHP classes
โ”‚   โ”œโ”€โ”€ helpers/             # Helper classes
โ”‚   โ”œโ”€โ”€ includes/            # Autoloader & includes
โ”‚   โ”œโ”€โ”€ integrations/        # Third-party integrations
โ”‚   โ””โ”€โ”€ templates/           # Template files
โ”œโ”€โ”€ assets/                   # Built/minified assets (generated)
โ”‚   โ”œโ”€โ”€ js/                  # Minified JavaScript
โ”‚   โ””โ”€โ”€ css/                 # Minified CSS
โ”œโ”€โ”€ tests/                    # Test files
โ”‚   โ”œโ”€โ”€ phpunit/             # PHP unit tests
โ”‚   โ””โ”€โ”€ e2e/                 # End-to-end tests
โ”œโ”€โ”€ vendor/                   # Composer dependencies (ignored)
โ”œโ”€โ”€ node_modules/            # npm dependencies (ignored)
โ”œโ”€โ”€ .github/workflows/       # CI/CD workflows
โ”œโ”€โ”€ docs/                    # Documentation
โ””โ”€โ”€ languages/               # Translation files

Code Quality Standards

This template follows:

  • PSR-4 autoloading
  • PSR-12 coding style (where not conflicting with WordPress)
  • WordPressยฎ VIP standards (takes precedence over PSR where conflicts exist)
  • WordPressยฎ Coding Standards for WordPress-specific code
  • Modern PHP practices (type declarations, readonly properties, etc.)

Linting Scope

Important: Linting and analysis tools only scan:

  • Root-level PHP files (e.g., sparxstar-plugin-entry.php)
  • src/ directory

Excluded from linting:

  • vendor/ - Third-party PHP dependencies
  • node_modules/ - Third-party JS dependencies
  • assets/ - Generated/minified files
  • tests/ - Test files (separate standards)
  • data/, examples/, schemas/ - Non-code directories

Workflows

Continuous Integration

Runs on every push/PR:

  • PHP linting (PHPCS) and analysis (PHPStan)
  • JavaScript/CSS linting
  • Unit tests (PHP & JS)
  • Asset building verification
  • Rector refactoring checks

Release Process

Triggered by pushing a version tag (v*):

  1. Updates version in all files
  2. Installs production dependencies
  3. Builds and minifies assets
  4. Generates translation files
  5. Creates distribution ZIP
  6. Generates checksums
  7. Creates GitHub release

To release:

git tag -a v1.2.3 -m "Release 1.2.3"
git push origin v1.2.3

Security Scanning

Weekly and on-demand:

  • Dependency audits (Composer & npm)
  • CodeQL analysis
  • Secret scanning
  • Security best practices checks

Accessibility Testing

Automated accessibility validation:

  • axe-core integration
  • WCAG 2.1 compliance
  • HTML validation

Configuration Files

File Purpose
phpcs.xml.dist PHP_CodeSniffer configuration
phpstan.neon.dist PHPStan static analysis
phpunit.xml.dist PHPUnit testing
rector.php Rector refactoring rules
eslint.config.js ESLint JavaScript linting
.stylelintrc.json Stylelint CSS linting
jest.config.js Jest testing configuration
playwright.config.js Playwright E2E testing
.distignore Files to exclude from releases
composer.json PHP dependencies & scripts
package.json Node dependencies & scripts

Requirements

  • PHP 8.2 or higher
  • WordPress 6.8 or higher
  • Node.js 20 or higher
  • Composer 2.x

License

This software is provided โ€œas isโ€, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.

MIT License - see LICENSE.md.

Copyright (c) 2026 Starisian Technologies (Max Barrett).

Credits

Created and maintained by Starisian Technologiesโ„ข .

Author: Max Barrett
Email: support@starisian.com

SPARXSTARโ„ข and Starisian Technologiesโ„ข are trademarks of Starisian Technologies. WordPressยฎ is a registered trademark of WordPress Inc. Starisian Technologies is in now way affiliated with WordPress.

Support

Contributing

See CONTRIBUTING.md for contribution guidelines and docs/FIRST_CONTRIBUTION.md for first-time contributors.

About

A template repository for SPARXSTAR projects: AI-powered tools and WordPress plugin development for SparxStar, AiWA, and language preservation projects. Includes custom code for linguistics, community contribution, and multilingual marketing automation.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •