Commit graph

629 commits

Author SHA1 Message Date
51eb77390f
chore: lint coc (#164)
* chore: lint coc

* Update README.md
2021-04-30 13:37:50 +01:00
Mark Cheret
1f28b5d102
docs: update author URL (#150) 2021-04-29 06:36:18 +01:00
Mark Cheret
fa5b74eb9f
Merge pull request #155 from markcheret/propose-coc-amendment
docs: amend code of conduct
2021-04-28 05:19:41 +02:00
Mark Cheret
979c26e57b
Merge branch 'main' into propose-coc-amendment 2021-04-28 05:17:35 +02:00
4af8849eec
ci: improve linting, GitHub Actions workflows (#149)
* release: release 2.7.2

* fix: urgent 2.7.3 release to fix fatal error

* chore: remove un-needed setup script

* ci: remove steps from pre-push command

* chore: remove un-needed PHP-Commitizen config

* chore: put image files in correct folders

* chore: move GitHub image into `.github/` dir

* fix: classic editor button

* fix: call correct jQuery Tools file in dev env

* docs: replace license with Markdown version

* ci: clean up PHP linting commands

If anyone has noticed me playing musical filepaths with these commands
for a while, it's because I kept getting inconsistent results from the
use of double-globs (i.e., `**`). However, I've finally figured out
that this is because Composer is running these scripts in its own shell,
so the double-glob that works when I run the command manually in my
Terminal doesn't work when Composer runs it in its.

* chore: lint PHP files

* build: update JS linting standards

* chore: lint JS file

* build: add node-sass

* build: add additional stylelint rules

* chore: lint stylesheets with new rulesets

* refactor: move ESLint settings to `package.json`

* chore: move Prettier config to `package.json`

It is not yet possible to move `.prettierignore` to `package.json` too,
but this appears to be on the horizon; see [this Issue][prettier-issue].

[prettier-issue]: https://github.com/prettier/prettier/issues/3460

* fix: move WPML config into Plugin folder

* chore: move Stylelint config into `package.json`

* chore: remove unused `.distignore`

It can always be re-added at a later date if it becomes useful.

* chore: format file

* build: add HTML linting

* fix: add image alt tag

* ci: clean up GitHub Actions workflows

* fix: fix workflow

* fix: fix indentation

* ci: add YAML validation

* chore: make valid

* ci: add YAML validation

* chore: lint code

* ci: change dep install back to original

* chore: lint license
2021-04-26 17:17:44 +01:00
ac819034e5
release: release 2.7.3 (#144)
* release: release 2.7.2

* fix: urgent 2.7.3 release to fix fatal error

* chore: remove un-needed setup script

* ci: remove steps from pre-push command

* chore: remove un-needed PHP-Commitizen config

* chore: put image files in correct folders

* chore: move GitHub image into `.github/` dir
2021-04-25 21:26:41 +01:00
6a1117be15
ci: improve release process, clean up and re-org repo, add automated minification (#143)
* ci: update scripts

* release 2.7.1

* remove tracked stylesheets

* docs: revert stable tag to 2.7.0

* chore: move Plugin source into own dir

* docs: delete info texts

These can now be found in the [project wiki][wiki].

[wiki]: https://github.com/markcheret/footnotes/wiki

* docs: tweak contributing guide

* ci: reflect new directory structure

* chore: update gitignore

* chore: reflect new dir structure

* docs: update documentation

* build(linting): add Husky hooks, Markdown linting, lint all MD files

* fix pre-push command

* fix pre-push command

* build: add stylesheet, JS minification

* ci: add linting steps

* ci: comment out CSS linting step (that's going to be a whole *thing*)

* ci: minify all JS files

* ci: call correct JS file

* chore: lint

* ci: fix PHP linting commands

* chore: increment version constant string

* ci: concat AMP stylesheets

* ci: improve build scripts

* chore: add assets dir
2021-04-25 09:28:02 +01:00
e780d817c1
docs: update WP readme (#139)
* docs: split changelog into separate file

See #137

* docs: add information to Plugin header

Fix #138

* docs: update WP readme

* docs: remove FAQs

* docs: remove installation instructions

These were causing the FAQ section to render incorrectly
when viewed in the [preview validator][validator].

Also, the [WP Plugin Handbook][wp-handbook] says that:
> If your plugin has no custom install settings, it's
> okay to omit this section.

[validator]: https://wpreadme.com/
[wp-handbook]: https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#installation

* docs: update links, versions, add extra changelog items

* docs: lower version to stable ver
2021-04-23 16:27:39 +01:00
Mark Cheret
e8bd3830dc
Merge pull request #130 from markcheret/security_add_snyk 2021-04-22 21:03:53 +02:00
Mark Cheret
8bab805bab
Merge pull request #131 from markcheret/rename-release-archive
ci: rename folder during release process
2021-04-20 14:44:39 +02:00
12c642a553 ci: rename folder during release process 2021-04-20 11:35:33 +01:00
Mark Cheret
70fdc9dcbd
doc: add snyk shield 2021-04-20 04:21:37 +02:00
Mark Cheret
b5af559ff4
activate specific push action 2021-04-20 04:07:08 +02:00
Mark Cheret
6cb765cb5a
updated settings on snyk.io 2021-04-20 04:05:00 +02:00
Mark Cheret
a5b86ec20c
update snyk.ymk 2021-04-20 03:59:19 +02:00
Mark Cheret
687c07da93
added license info in package 2021-04-20 03:48:16 +02:00
Mark Cheret
ec462f1a7b
update snyk.yml 2021-04-20 03:36:29 +02:00
Mark Cheret
f0503cceaf
updated snyk workflow 2021-04-20 03:30:57 +02:00
Mark Cheret
1e5d0b171f
security: add snyk 2021-04-20 03:28:19 +02:00
Mark Cheret
fe48c2b34a
Merge pull request #127 from markcheret/release-tweaks
ci: release process tweaks
2021-04-20 00:50:54 +02:00
e9438bc462 fix: (hopefully) fix CI script 2021-04-19 20:05:44 +01:00
3ae70069b3 fix: fix release and build scripts 2021-04-19 20:05:33 +01:00
95787e597c docs: add changelog 2021-04-19 20:04:29 +01:00
82c5d0f50f fix: add correct version tag 2021-04-19 20:04:18 +01:00
Mark Cheret
d809d00c23
Merge pull request #114 from markcheret/review-codebase 2021-04-19 13:32:37 +02:00
57d5e40532
Merge branch 'main' into review-codebase 2021-04-19 12:27:24 +01:00
2d4b778377 refactor: re-add Footnotes prefix to Hooks 2021-04-19 12:24:26 +01:00
7adab1cd45 fix: correct ref container class name 2021-04-19 12:19:56 +01:00
58683dd523 refactor: remove MCI prefixes 2021-04-19 12:16:05 +01:00
2f809f4fe9 Revert "refactor: remove Hungarian notation and MCI prefixes"
This reverts commit 1284544556.
2021-04-19 12:15:17 +01:00
Mark Cheret
f6a6852675
Merge pull request #125 from markcheret/dependabot/composer/marcocesarato/php-conventional-changelog-1.10.2
build(deps-dev): bump marcocesarato/php-conventional-changelog from 1.10.1 to 1.10.2
2021-04-19 11:44:21 +02:00
dependabot[bot]
e9334cb733
build(deps-dev): bump marcocesarato/php-conventional-changelog
Bumps [marcocesarato/php-conventional-changelog](https://github.com/marcocesarato/php-conventional-changelog) from 1.10.1 to 1.10.2.
- [Release notes](https://github.com/marcocesarato/php-conventional-changelog/releases)
- [Changelog](https://github.com/marcocesarato/php-conventional-changelog/blob/main/CHANGELOG.md)
- [Commits](https://github.com/marcocesarato/php-conventional-changelog/compare/v1.10.1...v1.10.2)

Signed-off-by: dependabot[bot] <support@github.com>
2021-04-19 09:33:05 +00:00
a754cd4fc2 docs: amend code of conduct
<opinion>
Explicit enumeration makes sense in legal documents, but CoCs are
more aspirational so I don't think it makes sense in this context.
You will end up either having to constantly add new things to the
list, or declare that the list is non-exhaustive (in which there's
not much point in enumerating in the first place).

This is doubly true given the inherently woolly realm of appropriate
interpersonal interactions that a CoC is implemented to moderate.

Also, remember the KISS principle. Personally, I think this is the
pinnacle of CoC design: https://github.com/karlgroves/dontbeadick
However, I'm sure there is a slightly-more-professional middle
ground ;)
</opinion>
2021-04-18 22:06:13 +01:00
Mark Cheret
cf16c8a066
Merge pull request #123 from markcheret/add-code-of-conduct-1
docs: add code of conduct
2021-04-18 22:56:15 +02:00
Mark Cheret
ae1b77730a
Merge pull request #122 from markcheret/markcheret-patch-1
Update README.md
2021-04-18 22:43:29 +02:00
Mark Cheret
6db94dafba
added sweet shields 2021-04-18 22:29:58 +02:00
Mark Cheret
5eb1b3040a
Create CODE_OF_CONDUCT.md 2021-04-18 22:02:30 +02:00
Mark Cheret
7ba0763c88
Update README.md 2021-04-18 21:58:11 +02:00
Mark Cheret
4dd3345685
docs: update readme and PHPDoc settings (#120)
* update readme.txt

* Test

* Test

* docs: update documentation

* docs: add package tag

* docs: add PHPDoc config, alter Composer script

Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
2021-04-18 20:30:42 +01:00
Mark Cheret
226df694a2
Merge pull request #118 from markcheret/fix_103
Fix paragraph separation
2021-04-18 00:59:50 +02:00
Mark Cheret
5b02a3dd08 fixing docblock formatting 2021-04-18 00:26:44 +02:00
Mark Cheret
fd9cb2aaa9
Update task.php
update docblock
2021-04-18 00:23:19 +02:00
Mark Cheret
dc1ec81ad9
Update task.php 2021-04-18 00:19:23 +02:00
Mark Cheret
3d85de134e
Update task.php
attribution
2021-04-17 23:32:43 +02:00
Mark Cheret
242795a2b6
Update task.php 2021-04-17 23:28:05 +02:00
Laurent Zimmerli
36e92bac3d Fix paragraph split, thanks to @pewgeuges 2021-04-17 22:45:50 +02:00
c0672461b0 build: increase commitizen lengths 2021-04-17 00:00:21 +01:00
1284544556 refactor: remove Hungarian notation and MCI prefixes
I had to use some RegEx-fu for this. Specifically:

```bash
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/\(p\|l\|a\)_\(str\|bool\|int\|obj\|flo\|arr\)_//g' {} \;
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/MCI_Footnotes/Footnotes/g' {} \;
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/C_\(INT\|STR\|FLO\)_//g' {} \;
```

This should have covered all the bases.

In my testing I encountered one error caused by these changes.
In the `add_select_box` function in `/class/dashboard/layout.php`,
there was a function parameter called `$p_arr_options` and a variable
called `$l_str_options`. Removing the Hungarian notation caused an
error as these two variables were both now called `$options`.

This has been fixed, and I like to think that that will have been
the only naming conflict, but I think it is more likely that there
maybe others. Further testing is required before I am happy calling
this release-ready.

Close #34, progress #36
2021-04-16 23:55:05 +01:00
df7160fad8 build: tweak commands 2021-04-16 23:49:32 +01:00
3af81c01b9 refactor: rename Hooks, update docblocks 2021-04-16 23:17:07 +01:00