Dartdoc: 마이그레이션되지 않은 패키지의 null 안전 주석

에 만든 2020년 10월 21일 · 10코멘트 · 출처: dart-lang/dartdoc

번식 단계:

# Extract package:retry version 3.0.1
$ curl -L https://storage.googleapis.com/pub-packages/packages/retry-3.0.1.tar.gz | tar -xz
$ pub get

# Get dartdoc from git
$ mkdir /source/dartdoc
$ git clone https://github.com/dart-lang/dartdoc.git /source/dartdoc
$ cd /source/dartdoc; pub get; cd -;

# Generate docs
$ dart /source/dartdoc/bin/dartdoc.dart

pubspec.yaml 대한 package:retry 에는 다음이 포함됩니다.

environment:
  sdk: ">=2.0.0 <3.0.0"

그리고 .dart_tool/package_config.json 는 package:retry 대한 언어 버전 2.0을 지정합니다.

{
  "configVersion": 2,
  "packages": [
    /* various other dependencies, mostly test and it's transitive dependencies, omitted here */
    {
      "name": "retry",
      "rootUri": "../",
      "packageUri": "lib/",
      "languageVersion": "2.0" // <-- language version 2.0, hence, no library in package:retry supports null-safety
    }
  ],
  "generated": "2020-10-21T10:44:27.912220Z",
  "generator": "pub",
  "generatorVersion": "2.10.0"
}

예상치 못한 결과:

3PjXUKmqd6fA2M4

retry 함수가 null 반환할 수 없는 것은 맞지만 패키지는 null-safety로 마이그레이션되지 않으므로 여기에 어떤 종류의 null-safety 태그를 추가해야 합니까?

P1 bug nnbd

출처

jonasfj

모든 10 댓글

메모. 개별 라이브러리가 null-safety를 선택 해제할 수 있는 것은 옳습니다. 따라서 함수나 클래스가 null-safety를 지원하는지 여부를 주석으로 표시하는 것이 중요하다고 주장할 수 있습니다.

그러나 널 안전으로 마이그레이션되는 대부분의 패키지의 경우 모든 라이브러리가 널 안전으로 마이그레이션됩니다.

편집: 나는 우리가 여기서 무엇을 해야 하는지 완전히 확신하지 못합니다. 언어 버전 >= 2.12.0이 없는 패키지의 라이브러리에 "null-safety"를 추가하는 것은 아마도 잘못된 것입니다.

jonasfj 에 2020년 10월 21일

이것은 아마도 틀릴 수 있다는 데 동의하십시오. 여기에서 무슨 일이 일어나고 있는지 확실하지 않지만 내일 조사하려고 노력할 것입니다. 그것이 널리 퍼진 경우(즉, 지금 우리는 어떤 이유로 이와 같이 모든 것을 표시하고 있습니다) 아마도 P1으로 상승해야 합니다.

jcollins-g 에 2020년 10월 21일

나는 분석기가 이것이 null-safe 패키지가 아니라는 사실을 여전히 알고 있다는 것을 알고 있지만, 이제 우리는 null 안전 태그를 여기저기에 뿌리고 있습니다.

jcollins-g 에 2020년 10월 21일

👍1

@jcollins-g 멤버 수준에서 이 태그를 원하는 적이 있습니까? 예를 들어 pub.dev와 같은 다른 곳에서는 null 안전을 패키지 수준 속성으로 취급할 것입니다(전체 패키지에 포함되거나 포함되지 않음).

mit-mit 에 2020년 10월 22일

@mit-mit 나는 그것에 대해 강한 의견이 없습니다. API 문서 모음을 탐색하고 패키지 경계를 넘을 때 null 안전 패키지에(또는 빠져나온) 때를 아는 것이 좋을 수 있으며 멤버 태그가 한 가지 방법이라는 주장이 있습니다. 저것.

jcollins-g 에 2020년 10월 22일

여기에 넣어도 될까요?

Screenshot 2020-10-22 at 21 05 14

mit-mit 에 2020년 10월 22일

👍1

API 문서 모음을 탐색하고 패키지 경계를 넘을 때 null 안전 패키지에(또는 빠져나온) 때를 아는 것이 좋을 수 있으며 멤버 태그가 한 가지 방법이라는 주장이 있습니다. 저것.

일반적으로 null-safe 패키지에서 null-safe하지 않은 패키지로 넘어지는 것이 가능합니까?

pub.dev 에서 pana pub.dev 의 분석은 다음과 같은 경우에만 패키지를 null-safety 를

언어 버전은 >=2.12 .
패키지에 _언어 버전 마커_( // @dart=2.5 )를 사용하여 null 안전을 선택 해제한 라이브러리가 없습니다.
현재 pub upgrade 해상도의 모든 종속성( dev_dependencies 제외)은 _null-safety_를 지원합니다(이 재귀 정의에 따름).

따라서 null 안전을 지원하는 패키지에 대한 문서를 읽기 시작하면 실수로 null 안전이 아닌 패키지/라이브러리를 우연히 발견할 가능성이 없습니다.

그러나 null-safe가 아닌 패키지에서 시작하는 경우 다른 방법으로 갈 수 있습니다. 그리고 Google 검색에서 문서 페이지를 찾아서 문서 페이지를 찾은 경우에도 알아두면 좋을 것 같습니다. 따라서 라이브러리 수준 레이블이 좋을 수 있습니다.

jonasfj 에 2020년 10월 23일

이것은 https://github.com/dart-lang/sdk/issues/43903 으로 인해 해결하기 어려운 문제로 밝혀졌으며 실험 플래그와 사용 방식으로 인해 해결하기 어려운 문제이기도 합니다. nullable이 아닌 경우. 이 문제는 플래그가 기본값이 되면 "사라질" 수 있습니다. 이 문제를 해결하려면 상당한 노력이 필요하기 때문에 플래그가 곧 분석기에서 기본 설정으로 설정된다는 가정 하에 태그가 잠시 동안 잘못되도록 내버려 두는 것이 좋습니다. 월요일에 분석 팀과 논의할 예정입니다. 대부분은 오늘 종료됩니다.

jcollins-g 에 2020년 10월 23일

나쁜 소식이 있습니다. 플래그를 기본값으로 설정해도 실제로 문제가 해결되지 않습니다. 따라서 이 문제를 해결하려면 추가 작업이 필요합니다. 좋은 소식은 @scheglov가 이미 #2309에서 이 문제를 해결하기 위해 분석기와 dartdoc에서 많은 작업을 수행했지만 업데이트해야 하고 일부 Windows 호환성 문제가 수정되어야 한다는 것입니다. 작업이 완료되면 이 버그를 수정할 수 있어야 합니다.

현재 #2309를 기반으로 한 PR을 시작하고 그가 직면한 문제를 수정하고 병합 충돌을 해결하기 위해 일하고 있습니다.

jcollins-g 에 2020년 10월 26일

이 문제를 해결하기 위해 업데이트된 버전의 #2309를 사용하려는 시도에 문제가 발생했습니다. 짧은 버전은 dartdoc이 기본이 아닌 리졸버가 필요한 일부 항목을 허용하므로 일부 테스트가 실패한다는 것입니다. 이것은 아마도 해결할 수 있지만 기간 내에 해결되지는 않습니다.

"수정"하려는 두 번째 시도는 dartdoc 내부의 pubspec 읽기 논리를 다시 구현했습니다. 이것은 어리석은 일이었지만 효과가 있었을 것입니다. @scheglov 는 이것이 패키지를 AnalysisDriver에 전달하지 않아 발생할 수 있다고 지적했으며 실제로 이를 수행하지 못했습니다.

2411은 올바른 패키지 구조를 AnalysisDriver에 전달하여 문제를 수정하여 수정 사항을 제공합니다.

AnalysisContextCollection에 대한 포트를 처리하기 위해 버그 #2410을 제출하여 해당 부채를 해결하지 못하면 미래에 이와 같은 더 혼란스러운 문제가 발생할 것입니다.

null 안전 태그의 위치 변경에 대한 @mit-mit의 의견을 구현하기 위해 버그 #2409를 제출했습니다.

#2411이 출시된 후 닫고 새 버전을 게시하기 위해 이동합니다.

jcollins-g 에 2020년 10월 30일

이 페이지가 도움이 되었나요?

0 / 5 - 0 등급

Dartdoc: 마이그레이션되지 않은 패키지의 null 안전 주석

모든 10 댓글

2411은 올바른 패키지 구조를 AnalysisDriver에 전달하여 문제를 수정하여 수정 사항을 제공합니다.

관련 문제