Skip to content

Commit

Permalink
update deps and optimize for midcore (#68)
Browse files Browse the repository at this point in the history
* update deps and optimize for midcore

* update deps and optimize for midcore part 2
  • Loading branch information
pirog authored Dec 9, 2024
1 parent 0bb9dcd commit 8d2a719
Show file tree
Hide file tree
Showing 24 changed files with 2,275 additions and 8,078 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
temp
cache
dist
examples/backdrop-init

_site
!.vitepress
19 changes: 16 additions & 3 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,36 @@
{
"env": {
"node": true,
"mocha": true
"mocha": true,
"es2021": true
},
"parser": "@babel/eslint-parser",
"parserOptions": {
"sourceType": "module",
"ecmaVersion": 8,
"requireConfigFile": false
},
"extends": "google",
"extends": [
"eslint:recommended",
"google"
],
"rules": {
"arrow-parens": ["error",
"as-needed"
],
"max-len": ["error", {
"code": 120,
"code": 140,
"ignoreComments": true
}],
"no-empty": ["error", {
"allowEmptyCatch": true
}],
"no-unused-vars": ["error", {
"vars": "all",
"args": "after-used",
"ignoreRestSiblings": false
}],

"require-jsdoc": ["error", {
"require": {
"FunctionDeclaration": true,
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr-backdrop-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ jobs:
- examples/backdrop-mysql8
- examples/backdrop-nginx
lando-version:
- 3-edge-slim
- 3-edge
os:
- ubuntu-24.04
node-version:
- '18'
- '20'
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-docs-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
os:
- ubuntu-24.04
node-version:
- '18'
- '20'
steps:
# Install deps and cache
- name: Checkout code
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
os:
- ubuntu-24.04
node-version:
- '18'
- '20'
steps:
# Install deps and cache
- name: Checkout code
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr-unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ jobs:
os:
- windows-2022
- ubuntu-24.04
- macos-12
- macos-14
node-version:
- '18'
- '20'
steps:
# Install deps and cache
- name: Checkout code
Expand Down
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18
20
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})

* Optimized for `midcore`
* Updated to [@lando/mariadb@1.6.3](https://github.com/lando/mariadb/releases/tag/v1.6.3).
* Updated to [@lando/mssql@1.4.3](https://github.com/lando/mssql/releases/tag/v1.4.3).
* Updated to [@lando/mysql@1.4.4](https://github.com/lando/mysql/releases/tag/v1.4.4).
* Updated to [@lando/php@1.6.3](https://github.com/lando/php/releases/tag/v1.6.3).
* Updated to [@lando/postgres@1.4.4](https://github.com/lando/postgres/releases/tag/v1.4.4).

## v1.6.3 - [December 6, 2024](https://github.com/lando/backdrop/releases/tag/v1.6.3)

* Updated the version index.md to get "Docuverse" page to build correctly.
Expand Down
4 changes: 2 additions & 2 deletions builders/backdrop-mariadb.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ const LandoMysql = require('./../node_modules/@lando/mariadb/builders/mariadb.js
module.exports = {
name: 'backdrop-mariadb',
parent: '_service',
builder: (parent, config) => class BackdropMariaDB extends LandoMysql.builder(parent, LandoMysql.config) {
builder: parent => class BackdropMariaDB extends LandoMysql.builder(parent, LandoMysql.config) {
constructor(id, options = {}) {
super(id, options, {services: _.set({}, options.name)});
};
}
},
};
4 changes: 2 additions & 2 deletions builders/backdrop-mssql.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ const LandoMssql = require('@lando/mssql/builders/mssql.js');
module.exports = {
name: 'backdrop-mssql',
parent: '_service',
builder: (parent, config) => class BackdropMssql extends LandoMssql.builder(parent, LandoMssql.config) {
builder: parent => class BackdropMssql extends LandoMssql.builder(parent, LandoMssql.config) {
constructor(id, options = {}) {
super(id, options, {services: _.set({}, options.name)});
};
}
},
};
4 changes: 2 additions & 2 deletions builders/backdrop-mysql.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ const LandoMysql = require('@lando/mysql/builders/mysql.js');
module.exports = {
name: 'backdrop-mysql',
parent: '_service',
builder: (parent, config) => class BackdropMysql extends LandoMysql.builder(parent, LandoMysql.config) {
builder: parent => class BackdropMysql extends LandoMysql.builder(parent, LandoMysql.config) {
constructor(id, options = {}) {
super(id, options, {services: _.set({}, options.name)});
};
}
},
};
2 changes: 1 addition & 1 deletion builders/backdrop-nginx.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ module.exports = {
builder: (parent, config) => class BackdropNginx extends PhpNginx.builder(parent, PhpNginx.config) {
constructor(id, options = {}) {
super(id, _.merge({}, config, options), {services: _.set({}, options.name)});
};
}
},
};
4 changes: 2 additions & 2 deletions builders/backdrop-php.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ const loadScripts = options => {
module.exports = {
name: 'backdrop-php',
parent: '_appserver',
builder: (parent, config) => class BackdropPhp extends LandoPhp.builder(parent, LandoPhp.config) {
builder: parent => class BackdropPhp extends LandoPhp.builder(parent, LandoPhp.config) {
constructor(id, options = {}, factory) {
loadScripts(options);
options.nginxServiceType = 'backdrop-nginx';
super(id, options, factory);
};
}
},
};
4 changes: 2 additions & 2 deletions builders/backdrop-postgres.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ const LandoPostgres = require('./../node_modules/@lando/postgres/builders/postgr
module.exports = {
name: 'backdrop-postgres',
parent: '_service',
builder: (parent, config) => class BackdropPostgres extends LandoPostgres.builder(parent, LandoPostgres.config) {
builder: parent => class BackdropPostgres extends LandoPostgres.builder(parent, LandoPostgres.config) {
constructor(id, options = {}) {
super(id, options, {services: _.set({}, options.name)});
};
}
},
};
2 changes: 1 addition & 1 deletion builders/backdrop.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ module.exports = {

// Downstream
super(id, options);
};
}
},
};
2 changes: 1 addition & 1 deletion docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default defineConfig({
],
themeConfig: {
multiVersionBuild: {
satisfies: '>=1.0.0',
satisfies: '>=1.6.0',
},
sidebar: sidebar(),
},
Expand Down
10 changes: 5 additions & 5 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: Learn how to configure the Lando Backdrop recipe.

# Configuration

While Lando [recipes](https://docs.lando.dev/core/v3/recipes.html) set sane defaults so they work out of the box, they are also [configurable](https://docs.lando.dev/core/v3/recipes.html#config).
While Lando [recipes](https://docs.lando.dev/landofile/recipes.html) set sane defaults so they work out of the box, they are also [configurable](https://docs.lando.dev/landofile/recipes.html#config).

Here are the configuration options, set to the default values, for this recipe's [Landofile](https://docs.lando.dev/core/v3). If you are unsure about where this goes or what this means, we *highly recommend* scanning the [recipes documentation](https://docs.lando.dev/core/v3/recipes.html) to get a good handle on how the magicks work.
Here are the configuration options, set to the default values, for this recipe's [Landofile](https://docs.lando.dev/landofile/). If you are unsure about where this goes or what this means, we *highly recommend* scanning the [recipes documentation](https://docs.lando.dev/landofile/recipes.html) to get a good handle on how the magicks work.

```yaml
recipe: backdrop
Expand All @@ -29,13 +29,13 @@ config:
backdrush: false
```
Note that if the above config options are not enough, all Lando recipes can be further [extended and overridden](https://docs.lando.dev/core/v3/recipes.html#extending-and-overriding-recipes).
Note that if the above config options are not enough, all Lando recipes can be further [extended and overridden](https://docs.lando.dev/landofile/recipes.html#extending-and-overriding-recipes).
## Choosing a php version
You can set `php` to any version that is available in our [php service](https://docs.lando.dev/plugins/php). However, you should consult the [Backdrop requirements](https://docs.backdropcms.org/documentation/system-requirements) to make sure that version is actually supported by Backdrop itself.
You can set `php` to any version that is available in our [php service](https://docs.lando.dev/plugins/php/). However, you should consult the [Backdrop requirements](https://docs.backdropcms.org/documentation/system-requirements) to make sure that version is actually supported by Backdrop itself.

The [recipe config](https://docs.lando.dev/core/v3/recipes.html#config) to set the Backdrop recipe to use `php` version `5.5` is shown below:
The [recipe config](https://docs.lando.dev/landofile/recipes.html#config) to set the Backdrop recipe to use `php` version `5.5` is shown below:

```yaml
recipe: backdrop
Expand Down
21 changes: 14 additions & 7 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,25 +91,32 @@ npm run test:unit

We do end to end testing with our made-just-for-Lando testing framework [Leia](https://github.com/lando/leia). Leia allows us to define tests as a series of commented shell commands in human readable markdown files. Here is a simple example:

```md
Start up tests
--------------
````md
## Start up tests

```bash
# Should start up successfully
lando start
```

Verification commands
---------------------
## Verification commands

```bash
# Should be able to connect to all mariadb relationships
lando mariadb main -e "show tables;"
Destroy tests
-------------
# Should do something else
lando exec appserver -- some-command
```

## Destroy tests

```bash
# Should be able to destroy our app
lando destroy -y
```
```` destroy -y
```

Note that the headers here are important. The _Start up tests_ header specifies things that should run before the main series of tests. _Verification commands_ is the main body of tests and is required. _Destroy tests_ specifies any needed clean up commands to run.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ description: Learn how to get started with the Lando Backdrop recipe.
Before you get started with this recipe we assume that you have:

1. [Installed Lando](https://docs.lando.dev/getting-started/installation.html) and gotten familiar with [its basics](https://docs.lando.dev/cli/)
2. [Initialized](https://docs.lando.dev/cli/init.html) a [Landofile](https://docs.lando.dev/core/v3) for your codebase for use with this recipe
3. Read about the various [services](https://docs.lando.dev/core/v3/services/lando.html), [tooling](https://docs.lando.dev/core/v3/tooling.html), [events](https://docs.lando.dev/core/v3/events.html) and [routing](https://docs.lando.dev/core/v3/proxy.html) Lando offers.
2. [Initialized](https://docs.lando.dev/cli/init.html) a [Landofile](https://docs.lando.dev/landofile/) for your codebase for use with this recipe
3. Read about the various [services](https://docs.lando.dev/services/lando-3.html), [tooling](https://docs.lando.dev/landofile/tooling.html), [events](https://docs.lando.dev/landofile/events.html) and [routing](https://docs.lando.dev/landofile/proxy.html) Lando offers.

## Quick Start

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ next: ./getting-started.html

[Backdrop CMS](https://backdropcms.org/) is the free and Open Source CMS that helps you build websites for businesses and non-profits.

Lando offers a configurable [recipe](https://docs.lando.dev/core/v3/recipes.html) for developing [Backdrop CMS](https://backdropcms.org/) apps.
Lando offers a configurable [recipe](https://docs.lando.dev/landofile/recipes.html) for developing [Backdrop CMS](https://backdropcms.org/) apps.

#### Features of this plugin:

Expand Down
2 changes: 1 addition & 1 deletion docs/tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can also run `lando` from inside your app directory for a complete list of c

If you are using a webroot besides `.`, you will need to `cd` into that directory and run `lando bee` from there. This is because many site-specific `bee` commands will only run correctly if you run `bee` from a directory that also contains a Backdrop site.

If you are annoyed by having to `cd` into that directory every time you run a `bee` command, you can get around it by [overriding](https://docs.lando.dev/core/v3/tooling.html#overriding) the `bee` tooling command in your [Landofile](https://docs.lando.dev/core/v3) so that bee always runs from your `webroot`.
If you are annoyed by having to `cd` into that directory every time you run a `bee` command, you can get around it by [overriding](https://docs.lando.dev/landofile/tooling.html#overriding) the `bee` tooling command in your [Landofile](https://docs.lando.dev/landofile/) so that bee always runs from your `webroot`.

**Note that hard coding the `root` like this may have unforeseen and bad consequences for some `bee` commands such as `bee scr`.**

Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
'use strict';

module.exports = lando => {};
module.exports = () => {};
Loading

0 comments on commit 8d2a719

Please sign in to comment.