docs: src/soapbox --> src

environments/review-src-ka9kj4/deployments/3924
Alex Gleason 2023-09-18 17:45:19 -05:00
rodzic 2b11b579a3
commit 3d582addf8
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 7211D1F99744FBB7
5 zmienionych plików z 12 dodań i 12 usunięć

Wyświetl plik

@ -295,7 +295,7 @@ module.exports = {
{ {
// Only enforce JSDoc comments on UI components for now. // Only enforce JSDoc comments on UI components for now.
// https://www.npmjs.com/package/eslint-plugin-jsdoc // https://www.npmjs.com/package/eslint-plugin-jsdoc
files: ['src/soapbox/components/ui/**/*'], files: ['src/components/ui/**/*'],
rules: { rules: {
'jsdoc/require-jsdoc': ['error', { 'jsdoc/require-jsdoc': ['error', {
publicOnly: true, publicOnly: true,

Wyświetl plik

@ -72,7 +72,7 @@ lint-sass:
# changes: # changes:
# - "**/*.js" # - "**/*.js"
# - "**/*.json" # - "**/*.json"
# - "src/soapbox/**/*" # - "src/**/*"
# - "webpack/**/*" # - "webpack/**/*"
# - "custom/**/*" # - "custom/**/*"
# - "jest.config.cjs" # - "jest.config.cjs"

Wyświetl plik

@ -1,7 +1,7 @@
import { danger, warn, message } from 'danger'; import { danger, warn, message } from 'danger';
// App changes // App changes
const app = danger.git.fileMatch('src/soapbox/**'); const app = danger.git.fileMatch('src/**');
// Docs changes // Docs changes
const docs = danger.git.fileMatch('docs/**/*.md'); const docs = danger.git.fileMatch('docs/**/*.md');
@ -18,24 +18,24 @@ if (app.edited && !changelog.edited) {
} }
// UI components // UI components
const uiCode = danger.git.fileMatch('src/soapbox/components/ui/**'); const uiCode = danger.git.fileMatch('src/components/ui/**');
const uiTests = danger.git.fileMatch('src/soapbox/components/ui/**/__tests__/**'); const uiTests = danger.git.fileMatch('src/components/ui/**/__tests__/**');
if (uiCode.edited && !uiTests.edited) { if (uiCode.edited && !uiTests.edited) {
warn('You have UI changes (`soapbox/components/ui`) without tests.'); warn('You have UI changes (`soapbox/components/ui`) without tests.');
} }
// Actions // Actions
const actionsCode = danger.git.fileMatch('src/soapbox/actions/**'); const actionsCode = danger.git.fileMatch('src/actions/**');
const actionsTests = danger.git.fileMatch('src/soapbox/actions/**__tests__/**'); const actionsTests = danger.git.fileMatch('src/actions/**__tests__/**');
if (actionsCode.edited && !actionsTests.edited) { if (actionsCode.edited && !actionsTests.edited) {
warn('You have actions changes (`soapbox/actions`) without tests.'); warn('You have actions changes (`soapbox/actions`) without tests.');
} }
// Reducers // Reducers
const reducersCode = danger.git.fileMatch('src/soapbox/reducers/**'); const reducersCode = danger.git.fileMatch('src/reducers/**');
const reducersTests = danger.git.fileMatch('src/soapbox/reducers/**__tests__/**'); const reducersTests = danger.git.fileMatch('src/reducers/**__tests__/**');
if (reducersCode.edited && !reducersTests.edited) { if (reducersCode.edited && !reducersTests.edited) {
warn('You have reducer changes (`soapbox/reducers`) without tests.'); warn('You have reducer changes (`soapbox/reducers`) without tests.');

Wyświetl plik

@ -71,7 +71,7 @@ For example:
} }
``` ```
See `src/soapbox/utils/features.js` for the full list of features. See `src/utils/features.js` for the full list of features.
### Embedded app (`custom/app.json`) ### Embedded app (`custom/app.json`)

Wyświetl plik

@ -48,7 +48,7 @@ Typically checks are done against `BACKEND_NAME` and `VERSION`.
The version string is similar in purpose to a [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) string. The version string is similar in purpose to a [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) string.
The format was first invented by Pleroma, but is now widely used, including by Pixelfed, Mitra, and Soapbox BE. The format was first invented by Pleroma, but is now widely used, including by Pixelfed, Mitra, and Soapbox BE.
See [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/src/soapbox/utils/features.ts) for the complete list of features. See [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/src/utils/features.ts) for the complete list of features.
## Forks of other software ## Forks of other software
@ -73,4 +73,4 @@ For Pleroma forks, the fork name should be in the compat section (eg Soapbox BE)
## Adding support for a new backend ## Adding support for a new backend
If the backend conforms to the above format, please modify [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/src/soapbox/utils/features.ts) and submit a merge request to enable features for your backend! If the backend conforms to the above format, please modify [`features.ts`](https://gitlab.com/soapbox-pub/soapbox/-/blob/main/src/utils/features.ts) and submit a merge request to enable features for your backend!