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

Feature/release #18

Merged
merged 5 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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: 0 additions & 4 deletions .browserslistrc

This file was deleted.

1 change: 0 additions & 1 deletion .eslintignore

This file was deleted.

3 changes: 0 additions & 3 deletions .eslintrc

This file was deleted.

6 changes: 0 additions & 6 deletions .gitattributes

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Project Specific
/public
/vendor
/vendor-prefixed
/node_modules
/storybook
.DS_Store
5 changes: 0 additions & 5 deletions .stylelintrc

This file was deleted.

36 changes: 23 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,55 @@

# Change Log for the Eightshift Boilerplate
# Change Log for the Eightshift Boilerplate Plugin
All notable changes to this project will be documented in this file.

This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a CHANGELOG](https://keepachangelog.com/).

## [4.0.0] - 2023-02-21

## [5.0.0]

### Update
- Boilerplate is clean and is using only temporary files used for the initial setup. After running the setup, the temporary files are removed and replaced with the actual files.

## [4.0.0]

### Update
- Updating packages.
- Full change log can be checked on Github [frontend-libs release](https://github.com/infinum/eightshift-frontend-libs/releases/tag/8.0.0) and [libs release](https://github.com/infinum/eightshift-libs/releases/tag/6.4.0).


## [3.0.0] - 2022-07-11
## [3.0.0]

- Updating packages-
### Update
- Updating packages
- Full change log can be checked on Github [frontend-libs release](https://github.com/infinum/eightshift-frontend-libs/releases/tag/7.0.0) and [libs release](https://github.com/infinum/eightshift-libs/releases/tag/6.0.0).

## [2.0.0] - 2021-08-16
## [2.0.0]

### Update
- Major braking changes do to updates on css variables, and helpers.

## [1.3.0] - 2020-05-25
## [1.3.0]

### Changed
- `Eightshift-frontend-libs` update.
- `Eightshift-libs` update.
- `composer.json` updated packages, fixing scripts names.

## [1.2.2] - 2020-05-15
## [1.2.2]

### Changed
- `Eightshift-frontend-libs` update.
- `Eightshift-libs` update.

## [1.2.1] - 2020-05-13
## [1.2.1]

### Changed
- `Eightshift-frontend-libs` update.
- `Eightshift-libs` update.
* Modified const name in wp-config-project.php from ES_ENV to EB_ENV to be consistent with the rest of the project.
* Adde eslint rule to ignore external dependencies from @eightshift/frontend-libs.
* Added eslint rule to ignore external dependencies from @eightshift/frontend-libs.

## [1.2.0] - 2020-05-06
## [1.2.0]

### Changed
- `Eightshift-frontend-libs` update.
Expand All @@ -56,19 +65,19 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a
**BRAKING CHANGES:**
- Please replace you old .babelrc file with the new one babel.config.js and convert it from .json to .js format.

## [1.1.0] - 2020-03-05
## [1.1.0]

### Changed
- Eightshift-frontend-libs update.
- Eightshift-libs update.

## [1.0.2] - 2020-01-29
## [1.0.2]

### Changed
- Eightshift-frontend-libs update
- Eightshift-libs update

## [1.0.1] - 2020-01-27
## [1.0.1]

### Changed
- Eightshift-frontend-libs update
Expand All @@ -81,6 +90,7 @@ Initial tagged release.

[Unreleased]: https://github.com/infinum/eightshift-boilerplate-plugin/compare/master...HEAD

[5.0.0]: https://github.com/infinum/eightshift-boilerplate-plugin/compare/4.0.0...5.0.0
[4.0.0]: https://github.com/infinum/eightshift-boilerplate-plugin/compare/3.0.0...4.0.0
[3.0.0]: https://github.com/infinum/eightshift-boilerplate-plugin/compare/2.0.0...3.0.0
[2.0.0]: https://github.com/infinum/eightshift-boilerplate-plugin/compare/v1.3.0...2.0.0
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 Infinum
Copyright Infinum

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
62 changes: 20 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,36 @@
[![GitHub stars](https://img.shields.io/github/stars/infinum/eightshift-boilerplate.svg?style=for-the-badge&label=Stars)](https://github.com/infinum/eightshift-boilerplate/)
[![license](https://img.shields.io/github/license/infinum/eightshift-boilerplate.svg?style=for-the-badge)](https://github.com/infinum/eightshift-boilerplate)

# Eightshift WordPress Boilerplate Plugin
## About Eightshift Boilerplate Plugin

This repository contains all the tools you need to start building a modern WordPress plugin, using all the latest front end development tools.
Eightshift Boilerplate is a modern, Gutenberg-oriented, WordPress plugin boilerplate. It includes everything you need to start building a modern WordPress project, using state-of-the-art frontend development tools, and it's at the core of the Eightshift Development Kit. [Find out more in Eightshift Docs →](https://eightshift.com)

## :books: Table of contents
- [:mortar_board: Documentation](#documentation)
- [:tada: Awesome features](#awesome-features)
- [:school_satchel: Requirements](#requirements)
- [:rocket: Quick start](#quick-start)
- [:mailbox: Who do I talk to?](#who-do-i-talk-to)
- [:scroll: License](#license)
## ⚠️ Requirements
To get started, you'll need:

## Documentation
**For more documentation details follow [this link](https://eightshift.com).**
* [Node LTS](https://nodejs.org/)
* [Composer](https://getcomposer.org/)
* [git](https://git-scm.com/)
* [WP-CLI](https://wp-cli.org/)

## Awesome features
## 🏁 Quick start

Here are some buzzwords why you should use Eightshift Boilerplate for your next project. For more documentation details follow [this link](https://eightshift.com).
If you'd like to get started ASAP, run `npx eightshift-create plugin` inside of `wp-content/plugins` to bootstrap your Eightshift Development Kit project.

- Custom Block Editor blocks
- OOP
- WP-CLI
- Webpack
- SASS
- Autoprefixer
- JS Compiler (Babel)
- Synchronised browser testing
- Minifying
- PHPCS
- Easy SASS media queries
- Cache busting
- Eightshift libs
- Eightshift Frontend Libs
[Documentation on getting started with Eightshift Boilerplate is available in Eightshift Docs →](https://eightshift.com/docs/theme/)

## Requirements
## 📚 Documentation

You can find all requirements on [this link](https://eightshift.com/docs/requirements).
Eightshift Development Kit comes with [comprehensive documentation](https://eightshift.com).

## Quick start
## 🛟 Getting help

You can find all steps necessary to start you project on [this link](https://eightshift.com/docs/plugin).
If you have any questions or problems, please [open an issue](https://github.com/infinum/eightshift-boilerplate-plugin/issues) on GitHub.

## Documentation
**For the full documentation please check this [link](https://eightshift.com).**
When submitting issues or otherwise participating in development, please follow our [code of conduct](https://github.com/infinum/eightshift-boilerplate-plugin/blob/develop/CODE_OF_CONDUCT.md), and fill out the issue template properly. We'll do our best to answer your issues as quickly as humanly possible: following these steps helps us out a lot in doing that.

## Who do I talk to?
## 👩‍💻 Maintainers 🧑‍💻
Eightshift Boilerplate is maintained and sponsored by [Infinum](https://infinum.com).

If you have any questions or problems, please [open an issue](https://github.com/infinum/eightshift-boilerplate-plugin/issues) on github and we will do our best to give you a timely answer.

## Maintainers
Eightshift Boilerplate is maintained and sponsored by
[Eightshift](https://eightshift.com) and [Infinum](https://infinum.com).

## License
Eightshift Boilerplate ©2022 [Eightshift](https://eightshift.com) and [Infinum](https://infinum.com). It is free software, and may be redistributed under the terms specified in the LICENSE file.
## ⚖️ License
Eightshift Boilerplate Plugin [Infinum](https://infinum.com). It is free software, and may be redistributed under the terms specified in the LICENSE file.
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

32 changes: 6 additions & 26 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{
"name": "eightshift/eightshift-boilerplate-plugin",
"description": "This repository contains all the tools you need to start building a modern WordPress project.",
"private": true,
"keywords": [
"composer",
"installer",
"plugin",
"blocks",
"eightshift",
"Gutenberg",
"WordPress"
],
Expand All @@ -24,40 +23,21 @@
"source": "https://github.com/infinum/eightshift-boilerplate-plugin"
},
"require-dev": {
"infinum/eightshift-coding-standards": "^1.6",
"dealerdirect/phpcodesniffer-composer-installer": "^0.7",
"szepeviktor/phpstan-wordpress": "^1.1.7",
"php-stubs/wordpress-stubs": "^6.1.1"
"wp-cli/wp-cli": "^2.9"
},
"require": {
"php": "^7.4 || <8.0",
"infinum/eightshift-libs": "^6.4.0",
"typisttech/imposter-plugin": "^0.6.2"
"php": "^7.4 || >=8.0"
},
"autoload": {
"psr-4": {
"EightshiftBoilerplate\\": "src/"
"EightshiftBoilerplatePlugin\\": "src/"
}
},
"minimum-stability": "dev",
"prefer-stable": true,
"config": {
"sort-packages": true,
"optimize-autoloader": true,
"process-timeout": 2000,
"allow-plugins": {
"dealerdirect/phpcodesniffer-composer-installer": true,
"typisttech/imposter-plugin": true
}
},
"scripts": {
"analyze": "@php ./vendor/bin/phpstan analyze",
"standards:check": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
"standards:fix": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
},
"extra": {
"imposter": {
"namespace": "EightshiftBoilerplatePluginVendor"
}
"process-timeout": 2000
}
}
43 changes: 43 additions & 0 deletions eightshift-boilerplate-plugin.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php

/**
* Plugin Name: Eightshift Boilerplate Setup Plugin
* Description: This is a initial setup for the Eightshift WordPress Boilerplate Plugin.
* Author: Eightshift team
* Author URI: https://eightshift.com/
* Version: 5.0.0
* License: MIT
* License URI: http://www.gnu.org/licenses/gpl.html
* Text Domain: eightshift-boilerplate-plugin
*
* @package EightshiftBoilerplatePlugin
*/

declare(strict_types=1);

namespace EightshiftBoilerplatePlugin;

use EightshiftLibs\Cli\Cli;

/**
* If this file is called directly, abort.
*/
if (! \defined('WPINC')) {
die;
}

/**
* Include the autoloader so we can dynamically include the rest of the classes.
*/
if (!\file_exists(__DIR__ . '/vendor/autoload.php')) {
return;
}

require __DIR__ . '/vendor/autoload.php';

/**
* Run all WPCLI commands.
*/
if (class_exists(Cli::class)) {
(new Cli())->load('boilerplate');
}
71 changes: 0 additions & 71 deletions eightshift-boilerplate.php

This file was deleted.

Loading