MNT Tidy up non-code files

silverstripe · Feb 12, 2024 · 4042f2f · 4042f2f
1 parent 447be6c
commit 4042f2f
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 77 deletions.
diff --git 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
@@ -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
@@ -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
diff --git 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
@@ -1,17 +1,8 @@
-<?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/cms/tests/bootstrap.php"
-         colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-    <coverage includeUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">src/</directory>
-        </include>
-        <exclude>
-            <directory suffix=".php">tests/</directory>
-        </exclude>
-    </coverage>
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
     <testsuites>
         <testsuite name="Default">
-            <directory>tests/</directory>
+            <directory>tests/php</directory>
         </testsuite>
     </testsuites>
 </phpunit>
diff --git 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`,