From 4042f2f2d91cc10f86668d29d0636771dd1814d0 Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Tue, 13 Feb 2024 11:43:24 +1300 Subject: [PATCH] MNT Tidy up non-code files --- .gitattributes | 6 +----- README.md | 10 ++-------- composer.json | 45 +++++++++++++++++++++------------------------ contributing.md | 12 ------------ package.json | 12 +++++------- phpunit.xml.dist | 15 +++------------ webpack.config.js | 18 +++++++++--------- 7 files changed, 41 insertions(+), 77 deletions(-) delete mode 100644 contributing.md diff --git a/.gitattributes b/.gitattributes index a665dee8..e8e50efa 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,11 +1,7 @@ -/tests/behat/features export-ignore -/tests/behat/files/ export-ignore -/tests/php export-ignore +/tests export-ignore /.tx export-ignore /.gitattributes export-ignore /.gitignore export-ignore -/.travis.yml export-ignore -/.scrutinizer.yml export-ignore /*.dist export-ignore /behat.yml export-ignore diff --git a/README.md b/README.md index f96872dc..f8942d6f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,7 @@ # Silverstripe link module -[![Build Status](https://github.com/silverstripe/silverstripe-linkfield/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-linkfield/actions/workflows/ci.yml) -[![Latest Stable Version](http://poser.pugx.org/silverstripe/linkfield/v)](https://packagist.org/packages/silverstripe/linkfield) -[![Total Downloads](http://poser.pugx.org/silverstripe/linkfield/downloads)](https://packagist.org/packages/silverstripe/linkfield) -[![Latest Unstable Version](http://poser.pugx.org/silverstripe/linkfield/v/unstable)](https://packagist.org/packages/silverstripe/linkfield) -[![License](http://poser.pugx.org/silverstripe/linkfield/license)](https://packagist.org/packages/silverstripe/linkfield) -[![PHP Version Require](http://poser.pugx.org/silverstripe/linkfield/require/php)](https://packagist.org/packages/silverstripe/linkfield) +[![CI](https://github.com/silverstripe/silverstripe-linkfield/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-linkfield/actions/workflows/ci.yml) +[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/) This module provides a Link model and CMS interface for managing different types of links. Including: @@ -17,8 +13,6 @@ This module provides a Link model and CMS interface for managing different types ## Installation -Installation via composer. - ```sh composer require silverstripe/linkfield ``` diff --git a/composer.json b/composer.json index 5bd4a59f..537f2082 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,18 @@ { "name": "silverstripe/linkfield", - "description": "Add advanced link functionality to Silverstripe.", + "description": "Link management for Silverstripe CMS", "type": "silverstripe-vendormodule", + "license": "BSD-3-Clause", + "authors": [ + { + "name": "Silverstripe", + "homepage": "https://silverstripe.com" + }, + { + "name": "The Silverstripe Community", + "homepage": "https://silverstripe.org" + } + ], "require": { "php": "^8.1", "silverstripe/framework": "^5.2", @@ -13,35 +24,21 @@ "silverstripe/recipe-testing": "^3", "squizlabs/php_codesniffer": "^3" }, - "license": "BSD-3-Clause", - "authors": [ - { - "name": "Maxime Rainville", - "email": "maxime@silverstripe.com" - } - ], - "extra": { - "branch-alias": { - "dev-2": "2.x-dev", - "dev-1": "1.x-dev" - }, - "expose": [ - "client/dist", - "client/lang" - ] - }, - "scripts": { - "lint": "phpcs src/ tests/php/", - "lint-clean": "phpcbf src/ tests/php/" - }, "autoload": { "psr-4": { "SilverStripe\\LinkField\\": "src/", "SilverStripe\\LinkField\\Tests\\": "tests/php/" } }, - "config": { - "process-timeout": 600 + "scripts": { + "lint": "phpcs src/ tests/php/", + "lint-clean": "phpcbf src/ tests/php/" + }, + "extra": { + "expose": [ + "client/dist", + "client/lang" + ] }, "minimum-stability": "dev", "prefer-stable": true diff --git a/contributing.md b/contributing.md deleted file mode 100644 index fa6fa4da..00000000 --- a/contributing.md +++ /dev/null @@ -1,12 +0,0 @@ -# Contributing - -Any open source product is only as good as the community behind it. You can participate by sharing code, ideas, or simply helping others. No matter what your skill level is, every contribution counts. - -See our [high level overview](http://silverstripe.org/contributing-to-silverstripe) on silverstripe.org on how you can help out. - -Or, for more detailed guidance, read one of the following pages: - - * [Sharing your opinion and raising issues](http://docs.silverstripe.org/en/3.2/contributing/issues_and_bugs/) - * [Providing code, whether it's creating a feature or fixing a bug](http://docs.silverstripe.org/en/3.2/contributing/code/) - * [Writing and translating documentation](http://docs.silverstripe.org/en/3.2/contributing/translations/) - * [Translating user-interface elements](http://docs.silverstripe.org/en/3.2/contributing/translation_process/) diff --git a/package.json b/package.json index 556e055e..ae93205e 100644 --- a/package.json +++ b/package.json @@ -1,18 +1,17 @@ { "name": "silverstripe-linkfield", - "version": "0.0.0", - "description": "Link management for the SilverStripe CMS", - "main": "./client/src/boot/index.js", + "version": "4.0.0", + "description": "Link management for Silverstripe CMS", "license": "BSD-3-Clause", "repository": { "type": "git", "url": "git+https://github.com/silverstripe/silverstripe-linkfield.git" }, - "homepage": "https://github.com/silverstripe/silverstripNe-linkfield", + "homepage": "https://github.com/silverstripe/silverstripe-linkfield", "bugs": { "url": "https://github.com/silverstripe/silverstripe-linkfield/issues" }, - "author": "SilverStripe Ltd", + "author": "Silverstripe Ltd", "engines": { "node": "^18.x" }, @@ -23,8 +22,7 @@ "css": "WEBPACK_CHILD=css npm run build", "test": "jest", "coverage": "jest --coverage", - "lock": "npm-shrinkwrap --dev", - "lint": "eslint client/src && sass-lint client/src", + "lint": "yarn lint-js && yarn lint-sass", "lint-js": "eslint client/src", "lint-js-fix": "eslint client/src --fix", "lint-sass": "sass-lint client/src" diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 2fdf2b19..a313a562 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,17 +1,8 @@ - - - - - src/ - - - tests/ - - + + - tests/ + tests/php diff --git a/webpack.config.js b/webpack.config.js index b1af7aa9..8bfe8e3b 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -7,16 +7,16 @@ const PATHS = { const config = [ new JavascriptWebpackConfig('js', PATHS) - .setEntry({ + .setEntry({ bundle: `${PATHS.SRC}/bundles/bundle.js` - }) - .mergeConfig({ - output: { - path: PATHS.DIST, - filename: 'js/[name].js', - }, - }) - .getConfig(), + }) + .mergeConfig({ + output: { + path: PATHS.DIST, + filename: 'js/[name].js', + }, + }) + .getConfig(), new CssWebpackConfig('css', PATHS) .setEntry({ bundle: `${PATHS.SRC}/styles/bundle.scss`,