Skip to content

Commit c3be0c5

Browse files
committed
fix(folderDescription): always use 'Readme.md' as filename
Fixes: #5953 Signed-off-by: Jonas <jonas@freesources.org>
1 parent 1e47bd1 commit c3be0c5

6 files changed

Lines changed: 13 additions & 7 deletions

File tree

cypress/e2e/workspace.spec.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,11 @@ describe('Workspace', function () {
173173
cy.get('#rich-workspace .ProseMirror').should('contain', 'Hello world')
174174
})
175175

176-
it('creates description with localized name properly rendered', function () {
176+
it('creates description with default name', function () {
177177
cy.modifyUser(user, 'language', 'es')
178178
cy.visitTestFolder()
179179
cy.createDescription('Añadir descripción a carpeta')
180-
cy.getFile('Léeme.md')
180+
cy.getFile('Readme.md')
181181
cy.get('#rich-workspace .editor__content').should('be.visible')
182182
})
183183

lib/Controller/WorkspaceController.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ public function direct(string $path): DataResponse {
169169
$file = $this->workspaceService->getFile($folder);
170170
if ($file === null) {
171171
$token = $this->directEditingManager->create(
172-
$path . '/' . $this->workspaceService->getSupportedFilenames()[0],
172+
$path . '/' . WorkspaceService::DEFAULT_FILENAME,
173173
Application::APP_NAME,
174174
TextDocumentCreator::CREATOR_ID
175175
);

lib/Service/WorkspaceService.php

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@
1919
class WorkspaceService {
2020
private IL10N $l10n;
2121

22+
public const DEFAULT_FILENAME = 'Readme.md';
23+
2224
private const SUPPORTED_STATIC_FILENAMES = [
23-
'Readme.md',
25+
self::DEFAULT_FILENAME,
2426
'README.md',
25-
'readme.md'
27+
'readme.md',
28+
'.Readme.md',
2629
];
2730

2831
public function __construct(IL10N $l10n) {

src/helpers/files.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const FILE_ACTION_IDENTIFIER = 'Edit with text app'
2424

2525
export const addMenuRichWorkspace = () => {
2626
const descriptionFile =
27-
t('text', 'Readme') + '.' + loadState('text', 'default_file_extension')
27+
'Readme' + '.' + loadState('text', 'default_file_extension')
2828
addNewFileMenuEntry({
2929
id: 'rich-workspace-init',
3030
displayName: t('text', 'Add folder description'),

src/views/RichWorkspace.vue

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ const WORKSPACE_URL = generateOcsUrl(
4646
'apps/text' + (IS_PUBLIC ? '/public' : '') + '/workspace',
4747
2,
4848
)
49-
const descriptionFile =
49+
const descriptionFile = 'Readme' + '.' + loadState('text', 'default_file_extension')
50+
const translatedDescriptionFile =
5051
t('text', 'Readme') + '.' + loadState('text', 'default_file_extension')
5152
const SUPPORTED_STATIC_FILENAMES = [
5253
descriptionFile,

tests/unit/Service/WorkspaceServiceTest.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ public function testGetFileReturnsFirstMatchingFileInPriorityOrder(): void {
5353
['docs/Readme.md', $readmeEntry],
5454
['docs/README.md', $uppercaseEntry],
5555
['docs/readme.md', false],
56+
['docs/.Readme.md', false],
5657
]);
5758

5859
$folder->expects($this->once())
@@ -81,6 +82,7 @@ public function testGetFileSkipsDirectoryCacheEntries(): void {
8182
['docs/Readme.md', $directoryEntry],
8283
['docs/README.md', false],
8384
['docs/readme.md', false],
85+
['docs/.Readme.md', false],
8486
]);
8587

8688
$folder->expects($this->never())->method('get');

0 commit comments

Comments
 (0)