Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Cannot have docs/ directory at the root of project #3326

@imaNNeo

Description

@imaNNeo

Environment

  • pub version or flutter pub version: Pub 2.16.1
  • OS version: macOS Big Sur version 11.4 (20F71)
  • Are you using the Chinese community mirror or a corporate firewall? No

Problem

I need to have a directory called docs at the root of my project (because I want to use docs.page service to generate documentation pages).
When I run flutter pub publish --dry-run it fails with the error below:

Package validation found the following potential issue:
* Rename the top-level "docs" directory to "doc".
  The Pub layout convention is to use singular directory names.
  Plural names won't be correctly identified by Pub and other tools.

Although I tried to put docs/ in my .pubignore file, it didn't work.

You can check this failing workflow for more details.

There is a similar closed issue here: #2976
I couldn't find any solution there.

Metadata

Metadata

Assignees

No one assigned

    Labels

    closed-not-plannedClosed as we don't intend to take action on the reported issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions