2017-12-14 21:15:04 -05:00
|
|
|
{
|
|
|
|
|
"name": "discourse",
|
2024-02-26 08:45:58 -05:00
|
|
|
"private": true,
|
2023-06-30 07:01:45 -04:00
|
|
|
"repository": "https://github.com/discourse/discourse",
|
2017-12-14 21:15:04 -05:00
|
|
|
"author": "Discourse",
|
2020-04-29 12:18:21 -04:00
|
|
|
"license": "GPL-2.0-only",
|
2023-06-30 07:01:45 -04:00
|
|
|
"devDependencies": {
|
2024-01-24 09:30:03 -05:00
|
|
|
"@discourse/lint-configs": "^1.3.5",
|
2023-08-24 10:36:22 -04:00
|
|
|
"@discourse/moment-timezone-names-translations": "^1.0.0",
|
|
|
|
|
"@fortawesome/fontawesome-free": "5.15.4",
|
2024-01-24 09:30:03 -05:00
|
|
|
"@glint/core": "^1.3.0",
|
|
|
|
|
"@glint/environment-ember-loose": "^1.3.0",
|
|
|
|
|
"@glint/environment-ember-template-imports": "^1.3.0",
|
|
|
|
|
"@glint/template": "^1.3.0",
|
2023-06-29 11:08:33 -04:00
|
|
|
"@json-editor/json-editor": "2.10.0",
|
2023-06-30 07:01:45 -04:00
|
|
|
"@mixer/parallel-prettier": "^2.0.3",
|
2021-12-29 11:02:37 -05:00
|
|
|
"ace-builds": "1.4.13",
|
2021-08-23 07:49:49 -04:00
|
|
|
"chart.js": "3.5.1",
|
2023-06-29 11:08:33 -04:00
|
|
|
"chartjs-plugin-datalabels": "2.2.0",
|
2022-11-17 18:03:05 -05:00
|
|
|
"chrome-launcher": "^0.15.1",
|
2022-11-17 17:21:10 -05:00
|
|
|
"chrome-remote-interface": "^0.31.3",
|
2024-02-26 09:12:33 -05:00
|
|
|
"concurrently": "^8.2.2",
|
2023-10-03 03:15:17 -04:00
|
|
|
"diffhtml": "1.0.0-beta.30",
|
2024-01-24 09:30:03 -05:00
|
|
|
"ember-template-lint": "^5.13.0",
|
2023-08-24 10:36:22 -04:00
|
|
|
"esbuild": "^0.19.2",
|
2024-02-26 09:16:29 -05:00
|
|
|
"eslint": "^8.57.0",
|
DEV: Chat service object initial implementation (#19814)
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux.
---
This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html
Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project.
Working with services generally involves 3 parts:
- The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy)
```ruby
class UpdateAge
include Chat::Service::Base
model :user, :fetch_user
policy :can_see_user
contract
step :update_age
class Contract
attribute :age, :integer
end
def fetch_user(user_id:, **)
User.find_by(id: user_id)
end
def can_see_user(guardian:, **)
guardian.can_see_user(user)
end
def update_age(age:, **)
user.update!(age: age)
end
end
```
- The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller
```ruby
def update
with_service(UpdateAge) do
on_success { render_serialized(result.user, BasicUserSerializer, root: "user") }
end
end
```
- Rspec matchers and steps inspector, improving the dev experience while creating specs for a service
```ruby
RSpec.describe(UpdateAge) do
subject(:result) do
described_class.call(guardian: guardian, user_id: user.id, age: age)
end
fab!(:user) { Fabricate(:user) }
fab!(:current_user) { Fabricate(:admin) }
let(:guardian) { Guardian.new(current_user) }
let(:age) { 1 }
it { expect(user.reload.age).to eq(age) }
end
```
Note in case of unexpected failure in your spec, the output will give all the relevant information:
```
1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user'
Failure/Error: it { is_expected.to fail_to_find_a_model(:user) }
Expected model 'foo' (key: 'result.model.user') was not found in the result object.
[1/4] [model] 'user' ❌
[2/4] [policy] 'can_see_user'
[3/4] [contract] 'default'
[4/4] [step] 'update_age'
/Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError)
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run'
from <internal:kernel>:90:in `tap'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call'
from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>'
```
2023-02-13 07:09:57 -05:00
|
|
|
"jsdoc": "^4.0.0",
|
2022-11-07 11:13:21 -05:00
|
|
|
"lefthook": "^1.2.0",
|
DEV: Setup lint to the future (#20990)
## How does this work?
Any time a lint rule is added or changed, you can run `yarn lint:fix` to handle all the auto-fixable situations.
But not all lints are auto-fixable -- for those, lint-to-the-future has tooling to automatically ignore present violations.
An alias has been added for lint-to-the-future to ignore new violations, `yarn lttf:ignore`.
The command will add lint-ignore declarations throughout all the files with present violations, which should then be committed.
An excerpt from lint-to-the-future's [README](https://github.com/mansona/lint-to-the-future#lint-to-the-future-dashboard):
> The point of Lint to the Future is to allow you to progressively update your codebase using new lint rules without overwhelming you with the task. You can easily ignore lint rules using project-based ignores in your config files but that doesn't prevent you from making the same errors in new files.
> We chose to do the ignores on a file basis as it is a perfect balance and it means that the tracking/graphing aspects of Lint to the Future provide you with achievable goals, especially in large codebases.
## How do I view progress?
lint-to-the-future provides graphs of violations-over-time per lint rule in a dashboard format, so we can track how well we're doing at cleaning up the violations.
To view the dashboard locally, run `yarn lint-progress` and visit `http://localhost:8084` (or whatever the port it chose, as it will choose a new port if 8084 is preoccupied)
Also there is a `list` command which shows a JSON object of:
```ts
{
[date: string]: { // yyyy-mm-dd
[pluginName: string]: {
[fileName: string]: string[]; // list of files with violations
}
}
}
```
```bash
yarn lint-to-the-future list --stdout
```
## What about lint-todo?
Lint todo is another system available for both eslint and ember-template-lint that _forces_ folks to "leave things better than they found them" by being transparent / line-specific ignoring of violations.
It was decided that for _this_ project, it made more sense, and would be less disruptive to new contributors to have the ignore declarations explicitly defined in each file (whereas in lint-todo, they are hidden).
To effectively use lint-todo, a whole team needs to agree to the workflow, and in open source, we want "just anyway" to be able to contribute, and throwing surprises at them can deter contributions.
2023-04-06 12:25:01 -04:00
|
|
|
"lint-to-the-future": "^2.0.0",
|
|
|
|
|
"lint-to-the-future-ember-template": "^1.1.1",
|
|
|
|
|
"lint-to-the-future-eslint": "^2.0.1",
|
2023-06-30 07:01:45 -04:00
|
|
|
"magnific-popup": "1.1.0",
|
|
|
|
|
"moment": "2.29.4",
|
|
|
|
|
"moment-timezone": "0.5.43",
|
2024-02-26 08:45:58 -05:00
|
|
|
"patch-package": "^8.0.0",
|
2023-08-24 08:25:44 -04:00
|
|
|
"pikaday": "1.8.2",
|
2024-02-26 08:45:58 -05:00
|
|
|
"postinstall-postinstall": "^2.1.0",
|
2023-10-23 06:08:35 -04:00
|
|
|
"prettier": "^2.8.8",
|
2023-08-16 01:06:45 -04:00
|
|
|
"puppeteer-core": "^21.0.3",
|
2023-06-30 07:01:45 -04:00
|
|
|
"squoosh": "discourse/squoosh#dc9649d",
|
2024-02-26 09:16:18 -05:00
|
|
|
"typescript": "^5.3.3"
|
2018-11-05 15:10:27 -05:00
|
|
|
},
|
|
|
|
|
"scripts": {
|
DEV: Setup lint to the future (#20990)
## How does this work?
Any time a lint rule is added or changed, you can run `yarn lint:fix` to handle all the auto-fixable situations.
But not all lints are auto-fixable -- for those, lint-to-the-future has tooling to automatically ignore present violations.
An alias has been added for lint-to-the-future to ignore new violations, `yarn lttf:ignore`.
The command will add lint-ignore declarations throughout all the files with present violations, which should then be committed.
An excerpt from lint-to-the-future's [README](https://github.com/mansona/lint-to-the-future#lint-to-the-future-dashboard):
> The point of Lint to the Future is to allow you to progressively update your codebase using new lint rules without overwhelming you with the task. You can easily ignore lint rules using project-based ignores in your config files but that doesn't prevent you from making the same errors in new files.
> We chose to do the ignores on a file basis as it is a perfect balance and it means that the tracking/graphing aspects of Lint to the Future provide you with achievable goals, especially in large codebases.
## How do I view progress?
lint-to-the-future provides graphs of violations-over-time per lint rule in a dashboard format, so we can track how well we're doing at cleaning up the violations.
To view the dashboard locally, run `yarn lint-progress` and visit `http://localhost:8084` (or whatever the port it chose, as it will choose a new port if 8084 is preoccupied)
Also there is a `list` command which shows a JSON object of:
```ts
{
[date: string]: { // yyyy-mm-dd
[pluginName: string]: {
[fileName: string]: string[]; // list of files with violations
}
}
}
```
```bash
yarn lint-to-the-future list --stdout
```
## What about lint-todo?
Lint todo is another system available for both eslint and ember-template-lint that _forces_ folks to "leave things better than they found them" by being transparent / line-specific ignoring of violations.
It was decided that for _this_ project, it made more sense, and would be less disruptive to new contributors to have the ignore declarations explicitly defined in each file (whereas in lint-todo, they are hidden).
To effectively use lint-todo, a whole team needs to agree to the workflow, and in open source, we want "just anyway" to be able to contribute, and throwing surprises at them can deter contributions.
2023-04-06 12:25:01 -04:00
|
|
|
"lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
|
|
|
|
|
"lint:fix": "concurrently \"npm:lint:*:fix\" --names \"fix:\"",
|
|
|
|
|
"lint:js": "eslint ./app/assets/javascripts --cache",
|
|
|
|
|
"lint:js-plugins": "eslint ./plugins --cache",
|
2023-10-10 14:38:59 -04:00
|
|
|
"lint:js:fix": "eslint --fix ./app/assets/javascripts",
|
|
|
|
|
"lint:js-plugins:fix": "eslint --fix ./plugins",
|
2023-07-20 16:01:12 -04:00
|
|
|
"lint:hbs": "ember-template-lint 'app/assets/javascripts/**/*.{gjs,hbs}' 'plugins/**/assets/javascripts/**/*.{gjs,hbs}' --no-error-on-unmatched-pattern",
|
|
|
|
|
"lint:hbs:fix": "ember-template-lint 'app/assets/javascripts/**/*.{gjs,hbs}' 'plugins/**/assets/javascripts/**/*.{gjs,hbs}' --no-error-on-unmatched-pattern --fix",
|
2023-09-06 08:23:06 -04:00
|
|
|
"lint:prettier": "yarn pprettier --list-different 'app/assets/stylesheets/**/*.scss' 'app/assets/javascripts/**/*.{js,gjs,hbs}' 'plugins/**/assets/stylesheets/**/*.scss' 'plugins/**/assets/javascripts/**/*.{js,gjs,hbs}'",
|
2023-07-20 16:01:12 -04:00
|
|
|
"lint:prettier:fix": "yarn prettier -w 'app/assets/stylesheets/**/*.scss' 'app/assets/javascripts/**/*.{js,gjs,hbs}' 'plugins/**/assets/stylesheets/**/*.scss' 'plugins/**/assets/javascripts/**/*.{js,gjs,hbs}'",
|
DEV: Setup lint to the future (#20990)
## How does this work?
Any time a lint rule is added or changed, you can run `yarn lint:fix` to handle all the auto-fixable situations.
But not all lints are auto-fixable -- for those, lint-to-the-future has tooling to automatically ignore present violations.
An alias has been added for lint-to-the-future to ignore new violations, `yarn lttf:ignore`.
The command will add lint-ignore declarations throughout all the files with present violations, which should then be committed.
An excerpt from lint-to-the-future's [README](https://github.com/mansona/lint-to-the-future#lint-to-the-future-dashboard):
> The point of Lint to the Future is to allow you to progressively update your codebase using new lint rules without overwhelming you with the task. You can easily ignore lint rules using project-based ignores in your config files but that doesn't prevent you from making the same errors in new files.
> We chose to do the ignores on a file basis as it is a perfect balance and it means that the tracking/graphing aspects of Lint to the Future provide you with achievable goals, especially in large codebases.
## How do I view progress?
lint-to-the-future provides graphs of violations-over-time per lint rule in a dashboard format, so we can track how well we're doing at cleaning up the violations.
To view the dashboard locally, run `yarn lint-progress` and visit `http://localhost:8084` (or whatever the port it chose, as it will choose a new port if 8084 is preoccupied)
Also there is a `list` command which shows a JSON object of:
```ts
{
[date: string]: { // yyyy-mm-dd
[pluginName: string]: {
[fileName: string]: string[]; // list of files with violations
}
}
}
```
```bash
yarn lint-to-the-future list --stdout
```
## What about lint-todo?
Lint todo is another system available for both eslint and ember-template-lint that _forces_ folks to "leave things better than they found them" by being transparent / line-specific ignoring of violations.
It was decided that for _this_ project, it made more sense, and would be less disruptive to new contributors to have the ignore declarations explicitly defined in each file (whereas in lint-todo, they are hidden).
To effectively use lint-todo, a whole team needs to agree to the workflow, and in open source, we want "just anyway" to be able to contribute, and throwing surprises at them can deter contributions.
2023-04-06 12:25:01 -04:00
|
|
|
"lttf:ignore": "lint-to-the-future ignore",
|
|
|
|
|
"lttf:output": "lint-to-the-future output -o ./lint-progress/",
|
|
|
|
|
"lint-progress": "yarn lttf:output && npx html-pages ./lint-progress --no-cache",
|
2024-02-26 08:45:58 -05:00
|
|
|
"postinstall": "./app/assets/javascripts/run-patch-package && rm -rf app/assets/javascripts/node_modules"
|
|
|
|
|
},
|
|
|
|
|
"workspaces": [
|
|
|
|
|
"app/assets/javascripts/admin",
|
|
|
|
|
"app/assets/javascripts/bootstrap-json",
|
|
|
|
|
"app/assets/javascripts/deprecation-silencer",
|
|
|
|
|
"app/assets/javascripts/dialog-holder",
|
|
|
|
|
"app/assets/javascripts/discourse",
|
|
|
|
|
"app/assets/javascripts/discourse-common",
|
|
|
|
|
"app/assets/javascripts/discourse-hbr",
|
|
|
|
|
"app/assets/javascripts/discourse-i18n",
|
|
|
|
|
"app/assets/javascripts/discourse-markdown-it",
|
|
|
|
|
"app/assets/javascripts/discourse-plugins",
|
|
|
|
|
"app/assets/javascripts/discourse-widget-hbs",
|
|
|
|
|
"app/assets/javascripts/ember-cli-progress-ci",
|
|
|
|
|
"app/assets/javascripts/ember-production-deprecations",
|
|
|
|
|
"app/assets/javascripts/float-kit",
|
|
|
|
|
"app/assets/javascripts/pretty-text",
|
|
|
|
|
"app/assets/javascripts/select-kit",
|
|
|
|
|
"app/assets/javascripts/theme-transpiler",
|
|
|
|
|
"app/assets/javascripts/truth-helpers"
|
|
|
|
|
],
|
|
|
|
|
"resolutions": {
|
|
|
|
|
"**/unset-value": "2.0.1"
|
2021-08-04 16:04:58 -04:00
|
|
|
},
|
|
|
|
|
"engines": {
|
2022-06-28 14:52:31 -04:00
|
|
|
"node": "16.* || >= 18",
|
2021-08-04 16:04:58 -04:00
|
|
|
"npm": "please-use-yarn",
|
|
|
|
|
"yarn": ">= 1.21.1"
|
2017-12-14 21:15:04 -05:00
|
|
|
}
|
|
|
|
|
}
|
