@atlaskit/ads-mcp 1.7.3 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -0
- package/README.md +9 -6
- package/dist/cjs/tools/get-all-components/components.codegen.js +2 -2
- package/dist/cjs/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
- package/dist/cjs/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +338 -1
- package/dist/cjs/tools/get-lint-rules/lint-rules-structured-content.codegen.js +3 -3
- package/dist/cjs/tools/search-tokens/list-search-tokens-tool.js +1 -1
- package/dist/cjs/tools/search-tokens/search-tokens-input-schema.js +2 -1
- package/dist/cjs/tools/search-tokens/search-tokens-tool.js +9 -6
- package/dist/es2019/tools/get-all-components/components.codegen.js +2 -2
- package/dist/es2019/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
- package/dist/es2019/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +338 -1
- package/dist/es2019/tools/get-lint-rules/lint-rules-structured-content.codegen.js +3 -3
- package/dist/es2019/tools/search-tokens/list-search-tokens-tool.js +1 -1
- package/dist/es2019/tools/search-tokens/search-tokens-input-schema.js +2 -1
- package/dist/es2019/tools/search-tokens/search-tokens-tool.js +6 -2
- package/dist/esm/tools/get-all-components/components.codegen.js +2 -2
- package/dist/esm/tools/get-atlaskit-components/atlaskit-components.codegen.js +2 -2
- package/dist/esm/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.js +338 -1
- package/dist/esm/tools/get-lint-rules/lint-rules-structured-content.codegen.js +3 -3
- package/dist/esm/tools/search-tokens/list-search-tokens-tool.js +1 -1
- package/dist/esm/tools/search-tokens/search-tokens-input-schema.js +2 -1
- package/dist/esm/tools/search-tokens/search-tokens-tool.js +9 -4
- package/dist/types/tools/get-all-components/components.codegen.d.ts +1 -1
- package/dist/types/tools/get-atlaskit-components/atlaskit-components.codegen.d.ts +1 -1
- package/dist/types/tools/get-atlaskit-utilities/atlaskit-utilities.codegen.d.ts +1 -1
- package/dist/types/tools/get-lint-rules/lint-rules-structured-content.codegen.d.ts +1 -1
- package/dist/types/tools/search-tokens/search-tokens-input-schema.d.ts +3 -0
- package/dist/types/tools/search-tokens/search-tokens-tool.d.ts +1 -1
- package/package.json +2 -2
|
@@ -9,7 +9,7 @@ exports.atlaskitUtilities = void 0;
|
|
|
9
9
|
*
|
|
10
10
|
* Structured content utilities from design-system *.docs.tsx files
|
|
11
11
|
*
|
|
12
|
-
* @codegen <<SignedSource::
|
|
12
|
+
* @codegen <<SignedSource::24334ce98583d7e675ff4422b14f94d3>>
|
|
13
13
|
* @codegenCommand yarn workspace @af/ads-ai-tooling codegen
|
|
14
14
|
*/
|
|
15
15
|
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention -- not our types */
|
|
@@ -701,4 +701,341 @@ var atlaskitUtilities = exports.atlaskitUtilities = [{
|
|
|
701
701
|
type: '(props: P) => JSX.Element'
|
|
702
702
|
},
|
|
703
703
|
signature: '<P extends object>(ComponentOld: ComponentType<P>, ComponentNext: ComponentType<P>, featureFlagFn: () => boolean) => (props: P) => JSX.Element'
|
|
704
|
+
}, {
|
|
705
|
+
name: 'A2uiSurfaceAdapterRovoMessage',
|
|
706
|
+
description: 'Public TypeScript type for the A2UI v0.9 SurfaceAdapterRovoMessage API.',
|
|
707
|
+
status: 'early-access',
|
|
708
|
+
keywords: ['a2ui', 'renderer', 'types', 'v0.9'],
|
|
709
|
+
category: 'ai',
|
|
710
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
711
|
+
examples: [],
|
|
712
|
+
kind: 'type'
|
|
713
|
+
}, {
|
|
714
|
+
name: 'A2uiSurfaceAdapterRovoProps',
|
|
715
|
+
description: 'Public TypeScript type for the A2UI v0.9 SurfaceAdapterRovoProps API.',
|
|
716
|
+
status: 'early-access',
|
|
717
|
+
keywords: ['a2ui', 'renderer', 'types', 'v0.9'],
|
|
718
|
+
category: 'ai',
|
|
719
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
720
|
+
examples: [],
|
|
721
|
+
kind: 'type'
|
|
722
|
+
}, {
|
|
723
|
+
name: 'ButtonAdapter',
|
|
724
|
+
description: 'The A2UI v0.9 component implementation registered for Button.',
|
|
725
|
+
status: 'early-access',
|
|
726
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
727
|
+
category: 'ai',
|
|
728
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
729
|
+
examples: [],
|
|
730
|
+
kind: 'constant'
|
|
731
|
+
}, {
|
|
732
|
+
name: 'CardAdapter',
|
|
733
|
+
description: 'The A2UI v0.9 component implementation registered for Card.',
|
|
734
|
+
status: 'early-access',
|
|
735
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
736
|
+
category: 'ai',
|
|
737
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
738
|
+
examples: [],
|
|
739
|
+
kind: 'constant'
|
|
740
|
+
}, {
|
|
741
|
+
name: 'CardBodyAdapter',
|
|
742
|
+
description: 'The A2UI v0.9 component implementation registered for CardBody.',
|
|
743
|
+
status: 'early-access',
|
|
744
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
745
|
+
category: 'ai',
|
|
746
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
747
|
+
examples: [],
|
|
748
|
+
kind: 'constant'
|
|
749
|
+
}, {
|
|
750
|
+
name: 'CardContentAdapter',
|
|
751
|
+
description: 'The A2UI v0.9 component implementation registered for CardContent.',
|
|
752
|
+
status: 'early-access',
|
|
753
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
754
|
+
category: 'ai',
|
|
755
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
756
|
+
examples: [],
|
|
757
|
+
kind: 'constant'
|
|
758
|
+
}, {
|
|
759
|
+
name: 'CardDescriptionAdapter',
|
|
760
|
+
description: 'The A2UI v0.9 component implementation registered for CardDescription.',
|
|
761
|
+
status: 'early-access',
|
|
762
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
763
|
+
category: 'ai',
|
|
764
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
765
|
+
examples: [],
|
|
766
|
+
kind: 'constant'
|
|
767
|
+
}, {
|
|
768
|
+
name: 'CardFooterAdapter',
|
|
769
|
+
description: 'The A2UI v0.9 component implementation registered for CardFooter.',
|
|
770
|
+
status: 'early-access',
|
|
771
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
772
|
+
category: 'ai',
|
|
773
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
774
|
+
examples: [],
|
|
775
|
+
kind: 'constant'
|
|
776
|
+
}, {
|
|
777
|
+
name: 'CardHeaderAdapter',
|
|
778
|
+
description: 'The A2UI v0.9 component implementation registered for CardHeader.',
|
|
779
|
+
status: 'early-access',
|
|
780
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
781
|
+
category: 'ai',
|
|
782
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
783
|
+
examples: [],
|
|
784
|
+
kind: 'constant'
|
|
785
|
+
}, {
|
|
786
|
+
name: 'CardLeadingAdapter',
|
|
787
|
+
description: 'The A2UI v0.9 component implementation registered for CardLeading.',
|
|
788
|
+
status: 'early-access',
|
|
789
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
790
|
+
category: 'ai',
|
|
791
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
792
|
+
examples: [],
|
|
793
|
+
kind: 'constant'
|
|
794
|
+
}, {
|
|
795
|
+
name: 'CardMediaAdapter',
|
|
796
|
+
description: 'The A2UI v0.9 component implementation registered for CardMedia.',
|
|
797
|
+
status: 'early-access',
|
|
798
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
799
|
+
category: 'ai',
|
|
800
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
801
|
+
examples: [],
|
|
802
|
+
kind: 'constant'
|
|
803
|
+
}, {
|
|
804
|
+
name: 'CardPrimaryContentAdapter',
|
|
805
|
+
description: 'The A2UI v0.9 component implementation registered for CardPrimaryContent.',
|
|
806
|
+
status: 'early-access',
|
|
807
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
808
|
+
category: 'ai',
|
|
809
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
810
|
+
examples: [],
|
|
811
|
+
kind: 'constant'
|
|
812
|
+
}, {
|
|
813
|
+
name: 'CardTitleAdapter',
|
|
814
|
+
description: 'The A2UI v0.9 component implementation registered for CardTitle.',
|
|
815
|
+
status: 'early-access',
|
|
816
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
817
|
+
category: 'ai',
|
|
818
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
819
|
+
examples: [],
|
|
820
|
+
kind: 'constant'
|
|
821
|
+
}, {
|
|
822
|
+
name: 'CheckBoxAdapter',
|
|
823
|
+
description: 'The A2UI v0.9 component implementation registered for CheckBox.',
|
|
824
|
+
status: 'early-access',
|
|
825
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
826
|
+
category: 'ai',
|
|
827
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
828
|
+
examples: [],
|
|
829
|
+
kind: 'constant'
|
|
830
|
+
}, {
|
|
831
|
+
name: 'ColumnAdapter',
|
|
832
|
+
description: 'The A2UI v0.9 component implementation registered for Column.',
|
|
833
|
+
status: 'early-access',
|
|
834
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
835
|
+
category: 'ai',
|
|
836
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
837
|
+
examples: [],
|
|
838
|
+
kind: 'constant'
|
|
839
|
+
}, {
|
|
840
|
+
name: 'createADSCatalog',
|
|
841
|
+
description: 'Creates the Atlassian Design System catalog used to register A2UI v0.9 component implementations.',
|
|
842
|
+
status: 'early-access',
|
|
843
|
+
keywords: ['a2ui', 'catalog', 'ads', 'v0.9'],
|
|
844
|
+
category: 'ai',
|
|
845
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
846
|
+
examples: [],
|
|
847
|
+
kind: 'function',
|
|
848
|
+
signature: 'createADSCatalog(): Catalog<ReactComponentImplementation>'
|
|
849
|
+
}, {
|
|
850
|
+
name: 'createSurface',
|
|
851
|
+
description: 'Creates an A2UI v0.9 surface from component entries and a catalog configuration.',
|
|
852
|
+
status: 'early-access',
|
|
853
|
+
keywords: ['a2ui', 'surface', 'renderer', 'v0.9'],
|
|
854
|
+
category: 'ai',
|
|
855
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
856
|
+
examples: [],
|
|
857
|
+
kind: 'function',
|
|
858
|
+
signature: 'createSurface(options: CreateSurfaceOptions): CreateSurfaceResult'
|
|
859
|
+
}, {
|
|
860
|
+
name: 'CreateSurfaceOptions',
|
|
861
|
+
description: 'Public TypeScript type for the A2UI v0.9 CreateSurfaceOptions API.',
|
|
862
|
+
status: 'early-access',
|
|
863
|
+
keywords: ['a2ui', 'renderer', 'types', 'v0.9'],
|
|
864
|
+
category: 'ai',
|
|
865
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
866
|
+
examples: [],
|
|
867
|
+
kind: 'type'
|
|
868
|
+
}, {
|
|
869
|
+
name: 'CreateSurfaceResult',
|
|
870
|
+
description: 'Public TypeScript type for the A2UI v0.9 CreateSurfaceResult API.',
|
|
871
|
+
status: 'early-access',
|
|
872
|
+
keywords: ['a2ui', 'renderer', 'types', 'v0.9'],
|
|
873
|
+
category: 'ai',
|
|
874
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
875
|
+
examples: [],
|
|
876
|
+
kind: 'type'
|
|
877
|
+
}, {
|
|
878
|
+
name: 'FieldAdapter',
|
|
879
|
+
description: 'The A2UI v0.9 component implementation registered for Field.',
|
|
880
|
+
status: 'early-access',
|
|
881
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
882
|
+
category: 'ai',
|
|
883
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
884
|
+
examples: [],
|
|
885
|
+
kind: 'constant'
|
|
886
|
+
}, {
|
|
887
|
+
name: 'FormAdapter',
|
|
888
|
+
description: 'The A2UI v0.9 component implementation registered for Form.',
|
|
889
|
+
status: 'early-access',
|
|
890
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
891
|
+
category: 'ai',
|
|
892
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
893
|
+
examples: [],
|
|
894
|
+
kind: 'constant'
|
|
895
|
+
}, {
|
|
896
|
+
name: 'FormFooterAdapter',
|
|
897
|
+
description: 'The A2UI v0.9 component implementation registered for FormFooter.',
|
|
898
|
+
status: 'early-access',
|
|
899
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
900
|
+
category: 'ai',
|
|
901
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
902
|
+
examples: [],
|
|
903
|
+
kind: 'constant'
|
|
904
|
+
}, {
|
|
905
|
+
name: 'FormHeaderAdapter',
|
|
906
|
+
description: 'The A2UI v0.9 component implementation registered for FormHeader.',
|
|
907
|
+
status: 'early-access',
|
|
908
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
909
|
+
category: 'ai',
|
|
910
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
911
|
+
examples: [],
|
|
912
|
+
kind: 'constant'
|
|
913
|
+
}, {
|
|
914
|
+
name: 'FormSectionAdapter',
|
|
915
|
+
description: 'The A2UI v0.9 component implementation registered for FormSection.',
|
|
916
|
+
status: 'early-access',
|
|
917
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
918
|
+
category: 'ai',
|
|
919
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
920
|
+
examples: [],
|
|
921
|
+
kind: 'constant'
|
|
922
|
+
}, {
|
|
923
|
+
name: 'getDefaultRovoCatalogs',
|
|
924
|
+
description: 'Returns the default upstream and Atlassian catalogs used by Rovo A2UI surfaces.',
|
|
925
|
+
status: 'early-access',
|
|
926
|
+
keywords: ['a2ui', 'rovo', 'catalog', 'v0.9'],
|
|
927
|
+
category: 'ai',
|
|
928
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
929
|
+
examples: [],
|
|
930
|
+
kind: 'function',
|
|
931
|
+
signature: 'getDefaultRovoCatalogs(): Catalog<ReactComponentImplementation>[]'
|
|
932
|
+
}, {
|
|
933
|
+
name: 'MultipleChoiceAdapter',
|
|
934
|
+
description: 'The A2UI v0.9 component implementation registered for MultipleChoice.',
|
|
935
|
+
status: 'early-access',
|
|
936
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
937
|
+
category: 'ai',
|
|
938
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
939
|
+
examples: [],
|
|
940
|
+
kind: 'constant'
|
|
941
|
+
}, {
|
|
942
|
+
name: 'RowAdapter',
|
|
943
|
+
description: 'The A2UI v0.9 component implementation registered for Row.',
|
|
944
|
+
status: 'early-access',
|
|
945
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
946
|
+
category: 'ai',
|
|
947
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
948
|
+
examples: [],
|
|
949
|
+
kind: 'constant'
|
|
950
|
+
}, {
|
|
951
|
+
name: 'TextAdapter',
|
|
952
|
+
description: 'The A2UI v0.9 component implementation registered for Text.',
|
|
953
|
+
status: 'early-access',
|
|
954
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
955
|
+
category: 'ai',
|
|
956
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
957
|
+
examples: [],
|
|
958
|
+
kind: 'constant'
|
|
959
|
+
}, {
|
|
960
|
+
name: 'TextFieldAdapter',
|
|
961
|
+
description: 'The A2UI v0.9 component implementation registered for TextField.',
|
|
962
|
+
status: 'early-access',
|
|
963
|
+
keywords: ['a2ui', 'renderer', 'adapter', 'v0.9'],
|
|
964
|
+
category: 'ai',
|
|
965
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
966
|
+
examples: [],
|
|
967
|
+
kind: 'constant'
|
|
968
|
+
}, {
|
|
969
|
+
name: 'V09ComponentEntry',
|
|
970
|
+
description: 'Public TypeScript type for the A2UI v0.9 ComponentEntry API.',
|
|
971
|
+
status: 'early-access',
|
|
972
|
+
keywords: ['a2ui', 'renderer', 'types', 'v0.9'],
|
|
973
|
+
category: 'ai',
|
|
974
|
+
package: '@atlassian/a2ui-renderer-next',
|
|
975
|
+
examples: [],
|
|
976
|
+
kind: 'type'
|
|
977
|
+
}, {
|
|
978
|
+
name: 'AnimatedIconAnimation',
|
|
979
|
+
description: 'The animation state accepted by the animated icon entry points.',
|
|
980
|
+
status: 'early-access',
|
|
981
|
+
keywords: ['animated', 'icon', 'animation', 'types'],
|
|
982
|
+
category: 'icons',
|
|
983
|
+
package: '@atlassian/animated-icon',
|
|
984
|
+
examples: [],
|
|
985
|
+
kind: 'type'
|
|
986
|
+
}, {
|
|
987
|
+
name: 'AnimatedIconProps',
|
|
988
|
+
description: 'Props shared by every animated icon entry point.',
|
|
989
|
+
status: 'early-access',
|
|
990
|
+
keywords: ['animated', 'icon', 'props', 'types'],
|
|
991
|
+
category: 'icons',
|
|
992
|
+
package: '@atlassian/animated-icon',
|
|
993
|
+
examples: [],
|
|
994
|
+
kind: 'type'
|
|
995
|
+
}, {
|
|
996
|
+
name: 'AvatarRelayProps',
|
|
997
|
+
description: 'Props accepted by AvatarRelay.',
|
|
998
|
+
status: 'early-access',
|
|
999
|
+
keywords: ['avatar', 'relay', 'types'],
|
|
1000
|
+
category: 'identity',
|
|
1001
|
+
package: '@atlassian/avatar-relay',
|
|
1002
|
+
examples: [],
|
|
1003
|
+
kind: 'type'
|
|
1004
|
+
}, {
|
|
1005
|
+
name: 'getAppearanceForAppType',
|
|
1006
|
+
description: 'Maps an Atlassian app type to the matching ADS Avatar appearance.',
|
|
1007
|
+
status: 'early-access',
|
|
1008
|
+
keywords: ['avatar', 'appearance', 'app-type', 'relay'],
|
|
1009
|
+
category: 'identity',
|
|
1010
|
+
package: '@atlassian/avatar-relay',
|
|
1011
|
+
examples: [],
|
|
1012
|
+
kind: 'function',
|
|
1013
|
+
signature: 'getAppearanceForAppType(appType: string | null | undefined): AppearanceType'
|
|
1014
|
+
}, {
|
|
1015
|
+
name: 'ThirdPartyLogoProps',
|
|
1016
|
+
description: 'Props shared by every generated third-party logo component.',
|
|
1017
|
+
status: 'early-access',
|
|
1018
|
+
keywords: ['third-party', 'logo', 'props', 'types'],
|
|
1019
|
+
category: 'images',
|
|
1020
|
+
package: '@atlassian/logo-third-party',
|
|
1021
|
+
examples: [],
|
|
1022
|
+
kind: 'type'
|
|
1023
|
+
}, {
|
|
1024
|
+
name: 'ThirdPartyLogoSize',
|
|
1025
|
+
description: 'The supported sizes for third-party logo components.',
|
|
1026
|
+
status: 'early-access',
|
|
1027
|
+
keywords: ['third-party', 'logo', 'size', 'types'],
|
|
1028
|
+
category: 'images',
|
|
1029
|
+
package: '@atlassian/logo-third-party',
|
|
1030
|
+
examples: [],
|
|
1031
|
+
kind: 'type'
|
|
1032
|
+
}, {
|
|
1033
|
+
name: 'ThirdPartyLogoType',
|
|
1034
|
+
description: 'The supported Tile and hexagon display types for third-party logo components.',
|
|
1035
|
+
status: 'early-access',
|
|
1036
|
+
keywords: ['third-party', 'logo', 'tile', 'hexagon', 'types'],
|
|
1037
|
+
category: 'images',
|
|
1038
|
+
package: '@atlassian/logo-third-party',
|
|
1039
|
+
examples: [],
|
|
1040
|
+
kind: 'type'
|
|
704
1041
|
}];
|
|
@@ -9,7 +9,7 @@ exports.lintRulesMcpStructuredContent = void 0;
|
|
|
9
9
|
*
|
|
10
10
|
* Structured content for MCP (JSON) for ESLint rule docs from constellation.
|
|
11
11
|
*
|
|
12
|
-
* @codegen <<SignedSource::
|
|
12
|
+
* @codegen <<SignedSource::6ba7bf9098b6455f755c4d8debdf36ae>>
|
|
13
13
|
* @codegenCommand yarn build structured-docs
|
|
14
14
|
*/
|
|
15
15
|
/* eslint-disable no-template-curly-in-string */
|
|
@@ -55,7 +55,7 @@ var lintRulesMcpStructuredContent = exports.lintRulesMcpStructuredContent = [{
|
|
|
55
55
|
ruleName: 'icon-label',
|
|
56
56
|
description: 'Icon labels are used to describe what the icon is so the visually impaired can be described what the'
|
|
57
57
|
}, {
|
|
58
|
-
content: '{"ruleName":"index","description":"---","content":"---\\norder: 0\\n---\\n\\nThis plugin contains rules that should be used when working with the\\n[Atlassian Design System](https://atlassian.design).\\n\\n## Rules\\n\\n<!-- START_RULE_TABLE_CODEGEN -->\\n<!-- @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen -->\\n\\n| Rule | Description | Recommended | Fixable | Suggestions |\\n| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | ----------- |\\n| <a href=\\"/components/eslint-plugin-design-system/consistent-css-prop-usage/usage\\">consistent-css-prop-usage</a> | Ensures consistency with `css` and `xcss` prop usages | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/enforce-inline-styles-in-select/usage\\">enforce-inline-styles-in-select</a> | Disallow unsupported CSS selectors in styles prop for @atlaskit/select and require inline styles only | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-avatar-tag-avatar-props/usage\\">ensure-avatar-tag-avatar-props</a> | Ensures AvatarTag avatar prop does not include controlled props (size, borderColor, appearance) which are managed internally. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-design-token-usage/usage\\">ensure-design-token-usage</a> | Enforces usage of design tokens rather than hard-coded values. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-design-token-usage-preview/usage\\">ensure-design-token-usage/preview</a> | Enforces usage of pre-release design tokens rather than hard-coded values. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-icon-color/usage\\">ensure-icon-color</a> | Enforces that upcoming icon components have a color prop set, to enable a migration of the default value. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-proper-xcss-usage/usage\\">ensure-proper-xcss-usage</a> | Enforces proper xcss usage: migrate from xcss() to cssMap() and use cssMap objects with specific keys. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/expand-motion-shorthand/usage\\">expand-motion-shorthand</a> | Expands `transition` and `animation` CSS shorthand properties into their individual sub-properties, so individual values can be replaced with motion tokens. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/icon-label/usage\\">icon-label</a> | Enforces accessible usage of icon labels when composed with Atlassian Design System components. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/lozenge-badge-tag-labelling-system-migration/usage\\">lozenge-badge-tag-labelling-system-migration</a> | Helps migrate Lozenge isBold prop, Badge appearance values, and SimpleTag/RemovableTag components as part of the Labelling System Phase 1 migration. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-banned-imports/usage\\">no-banned-imports</a> | Disallow importing banned modules. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-css-map-scoped/usage\\">no-css-map-scoped</a> | Disallows usage of the experimental `cssMapScoped` API from `@compiled/react`. This API is internal and is not part of the public Compiled CSS-in-JS interface. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-css-tagged-template-expression/usage\\">no-css-tagged-template-expression</a> | Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-dark-theme-vr-tests/usage\\">no-dark-theme-vr-tests</a> | Disallow using dark colorScheme in VR tests. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-deprecated-apis/usage\\">no-deprecated-apis</a> | Disallow using deprecated APIs. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-deprecated-design-token-usage/usage\\">no-deprecated-design-token-usage</a> | Disallow using deprecated design tokens. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-deprecated-imports/usage\\">no-deprecated-imports</a> | Disallow importing deprecated modules. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-direct-use-of-web-platform-drag-and-drop/usage\\">no-direct-use-of-web-platform-drag-and-drop</a> | Disallow using direct use of native drag and drop (please use Pragmatic drag and drop) | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-emotion-primitives/usage\\">no-emotion-primitives</a> | Ensures usage of Compiled Primitives import instead of Emotion entrypoint. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-empty-styled-expression/usage\\">no-empty-styled-expression</a> | Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements). | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-exported-css/usage\\">no-exported-css</a> | Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-exported-keyframes/usage\\">no-exported-keyframes</a> | Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-anchor/usage\\">no-html-anchor</a> | Discourage direct usage of HTML anchor elements in favor of Atlassian Design System link components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-button/usage\\">no-html-button</a> | Discourage direct usage of HTML button elements in favor of Atlassian Design System button components. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-checkbox/usage\\">no-html-checkbox</a> | Discourage direct usage of HTML checkbox elements in favor of the Atlassian Design System checkbox component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-code/usage\\">no-html-code</a> | Discourage direct usage of HTML code elements in favor of the Atlassian Design System code component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-heading/usage\\">no-html-heading</a> | Discourage direct usage of HTML heading elements in favor of Atlassian Design System heading components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-image/usage\\">no-html-image</a> | Discourage direct usage of HTML image elements in favor of the Atlassian Design System image component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-radio/usage\\">no-html-radio</a> | Discourage direct usage of HTML radio elements in favor of the Atlassian Design System radio component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-range/usage\\">no-html-range</a> | Discourage direct usage of HTML range elements in favor of the Atlassian Design System range component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-select/usage\\">no-html-select</a> | Discourage direct usage of HTML select elements in favor of the Atlassian Design System select component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-text-input/usage\\">no-html-text-input</a> | Discourage direct usage of HTML text input elements in favor of the Atlassian Design System textfield component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-textarea/usage\\">no-html-textarea</a> | Discourage direct usage of HTML textarea elements in favor of the Atlassian Design System textarea component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-icon-spacing-prop/usage\\">no-icon-spacing-prop</a> | Disallows usage of the deprecated spacing prop on new icons. Use Flex with cssMap for spacing instead. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-invalid-css-map/usage\\">no-invalid-css-map</a> | Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript\'s type-checking. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-keyframes-tagged-template-expression/usage\\">no-keyframes-tagged-template-expression</a> | Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-margin/usage\\">no-margin</a> | Disallow using the margin CSS property. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-modal-label/usage\\">no-modal-label</a> | Disallows usage of the `label` prop on Atlassian Design System modal dialog. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-nested-styles/usage\\">no-nested-styles</a> | Disallows use of nested styles in `css` functions. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-physical-properties/usage\\">no-physical-properties</a> | Disallow physical properties and values in `css` and `cssMap` function calls. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-placeholder/usage\\">no-placeholder</a> | Placeholders should not be used. If information should be given to the user about the proper type or formatting of a value, this should be included using a helper message that is associated to the input instead. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-readonly-or-disabled-inputs/usage\\">no-readonly-or-disabled-inputs</a> | Inputs should almost always be interactive. Disabled and read-only inputs can usually be replaced by a more user-friendly design pattern. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-separator-with-list-elements/usage\\">no-separator-with-list-elements</a> | Warn when the `separator` prop is used with `as=\\"li\\"`, `as=\\"ol\\"`, or `as=\\"dl\\"` in the Inline component. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-styled-tagged-template-expression/usage\\">no-styled-tagged-template-expression</a> | Disallows any `styled` tagged template expressions that originate from Emotion, Styled Components or Compiled | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-to-match-snapshot/usage\\">no-to-match-snapshot</a> | Disallow using toMatchSnapshot() in favor of toMatchInlineSnapshot(). See https://hello.atlassian.net/wiki/spaces/DST/pages/6105892000/DSTRFC-038+-+Removal+of+.toMatchSnapshot for rationale. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsafe-design-token-usage/usage\\">no-unsafe-design-token-usage</a> | Enforces design token usage is statically and locally analyzable. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsafe-inline-snapshot/usage\\">no-unsafe-inline-snapshot</a> | Enforce guardrails on toMatchInlineSnapshot usage: snapshots must not exceed 100 lines and must not contain internal implementation details like className or style attributes. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsafe-style-overrides/usage\\">no-unsafe-style-overrides</a> | Discourage usage of unsafe style overrides used against the Atlassian Design System. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsupported-drag-and-drop-libraries/usage\\">no-unsupported-drag-and-drop-libraries</a> | Disallow importing unsupported drag and drop modules. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unused-css-map/usage\\">no-unused-css-map</a> | Detects unused styles in cssMap objects to help keep code clean. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/prefer-primitives/usage\\">prefer-primitives</a> | Increase awareness of primitive components via code hints. Strictly used for education purposes and discoverability. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-button-group-label/usage\\">use-button-group-label</a> | Ensures button groups are described to assistive technology by a direct label or by another element. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-character-counter-field/usage\\">use-character-counter-field</a> | Suggests using CharacterCounterField or CharacterCounter when Textfield or Textarea components have maxLength or minLength props. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-correct-field/usage\\">use-correct-field</a> | Ensure makers use appropriate field component for their respective form elements. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-cx-function-in-xcss/usage\\">use-cx-function-in-xcss</a> | Enforces cx function use to combine styles in xcss. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-datetime-picker-calendar-button/usage\\">use-datetime-picker-calendar-button</a> | Encourages makers to use calendar button in Atlassian Design System\'s date picker and datetime picker components. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-drawer-label/usage\\">use-drawer-label</a> | Encourages to provide accessible name for Atlassian Design System Drawer component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-field-message-wrapper/usage\\">use-field-message-wrapper</a> | Encourage use of message wrapper component when using form message components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-heading/usage\\">use-heading</a> | Encourage the usage of heading components. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-heading-level-in-section-message/usage\\">use-heading-level-in-section-message</a> | The `SectionMessage` component in `@atlaskit/section-message` needs to be the correct level within the document flow. This is not something that can be automated and requires contextual knowledge of what is present in the experience. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-heading-level-in-spotlight-card/usage\\">use-heading-level-in-spotlight-card</a> | Inform developers of eventual requirement of `headingLevel` prop in `SpotlightCard` component. The heading level should be the appropriate level according to the surrounding context. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-href-in-link-item/usage\\">use-href-in-link-item</a> | Inform developers of eventual requirement of `href` prop in `LinkItem` component. Elements with a `link` role require an `href` attribute for users to properly navigate, particularly those using assistive technologies. If no valid `href` is required for your use case, consider using a `ButtonItem` instead. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-latest-xcss-syntax/usage\\">use-latest-xcss-syntax</a> | Enforces usage of space design tokens rather than hard-coded values in xcss. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-latest-xcss-syntax-typography/usage\\">use-latest-xcss-syntax-typography</a> | Prohibits use of unsafe styling properties in xcss. Please use Text/Heading primitives instead. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-menu-section-title/usage\\">use-menu-section-title</a> | Encourages makers to provide accessible title for Atlassian Design System Menu Section component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-modal-dialog-close-button/usage\\">use-modal-dialog-close-button</a> | Encourages makers to use close button in Atlassian Design System\'s modal dialog component. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-modal-title/usage\\">use-modal-title</a> | Encourages makers to include `ModalTitle` within `ModalHeader` when using Atlassian Design System modal dialog. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-onboarding-spotlight-label/usage\\">use-onboarding-spotlight-label</a> | Ensures onboarding spotlight dialogs are described to assistive technology by a direct label or by another element. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-popup-label/usage\\">use-popup-label</a> | Encourages to provide accessible name for Atlassian Design System Popup component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-pressable-motion/usage\\">use-pressable-motion</a> | Suggests semantic motion tokens when Pressable or native buttons change interactive colours through local static styles. | | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-primitives-text/usage\\">use-primitives-text</a> | Encourage the usage of text components. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-should-render-to-parent/usage\\">use-should-render-to-parent</a> | Encourages makers to use the `shouldRenderToParent` where possible in Atlassian Design System `Popup` and `DropdownMenu` components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-simple-field/usage\\">use-simple-field</a> | Encourage use of simple field for better developer experience and accessibility. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-simple-form/usage\\">use-simple-form</a> | Encourage use of simple form for better developer experience and accessibility. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-spotlight-package/usage\\">use-spotlight-package</a> | Discourage the use of @atlaskit/onboarding in favor of @atlaskit/spotlight. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tag-group-label/usage\\">use-tag-group-label</a> | Ensures tag groups are described to assistive technology by a direct label or by another element. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-textfield-autocomplete/usage\\">use-textfield-autocomplete</a> | Enforce that Textfield components with type=\\"email\\", \\"tel\\", or \\"url\\" have an appropriate autocomplete value for WCAG 2.2 SC 1.3.5 compliance (Identify Input Purpose). | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-motion/usage\\">use-tokens-motion</a> | Enforces usage of motion design tokens rather than hard-coded duration and easing values. | | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-shape/usage\\">use-tokens-shape</a> | Enforces usage of shape design tokens rather than hard-coded values. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-space/usage\\">use-tokens-space</a> | Enforces usage of space design tokens rather than hard-coded values. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-typography/usage\\">use-tokens-typography</a> | Enforces usage of design tokens for typography properties rather than hard-coded values. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-visually-hidden/usage\\">use-visually-hidden</a> | Enforce usage of the visually hidden component. | Yes | Yes | |\\n\\n<!-- END_RULE_TABLE_CODEGEN -->\\n\\n\\n## Props\\n\\nUse the recommended config to get reasonable defaults recommended by the Atlassian Design System:\\n\\n```diff\\nmodule.exports = {\\n extends: [\\n+ \'plugin:@atlaskit/design-system/recommended\',\\n ],\\n};\\n```\\n\\nWe don\'t recommended maintaining your own configuration. If you do not use our config you will need\\nto specify individual rules and configuration. Add the plugin to your `eslint.config.cjs` file.\\n\\n```diff\\nmodule.exports = {\\n plugins: [\\n+ \'@atlaskit/design-system\',\\n ],\\n};\\n```\\n\\nEnable the rules that you would like to use.\\n\\n```diff\\nmodule.exports = {\\n rules: [\\n+ \'@atlaskit/design-system/no-deprecated-apis\': \'error\',\\n ],\\n};\\n```\\n"}',
|
|
58
|
+
content: '{"ruleName":"index","description":"---","content":"---\\norder: 0\\n---\\n\\nThis plugin contains rules that should be used when working with the\\n[Atlassian Design System](https://atlassian.design).\\n\\n## Rules\\n\\n<!-- START_RULE_TABLE_CODEGEN -->\\n<!-- @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen -->\\n\\n| Rule | Description | Recommended | Fixable | Suggestions |\\n| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | ----------- |\\n| <a href=\\"/components/eslint-plugin-design-system/consistent-css-prop-usage/usage\\">consistent-css-prop-usage</a> | Ensures consistency with `css` and `xcss` prop usages | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/enforce-inline-styles-in-select/usage\\">enforce-inline-styles-in-select</a> | Disallow unsupported CSS selectors in styles prop for @atlaskit/select and require inline styles only | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-avatar-tag-avatar-props/usage\\">ensure-avatar-tag-avatar-props</a> | Ensures AvatarTag avatar prop does not include controlled props (size, borderColor, appearance) which are managed internally. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-design-token-usage/usage\\">ensure-design-token-usage</a> | Enforces usage of design tokens rather than hard-coded values. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-design-token-usage-preview/usage\\">ensure-design-token-usage/preview</a> | Enforces usage of pre-release design tokens rather than hard-coded values. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-icon-color/usage\\">ensure-icon-color</a> | Enforces that upcoming icon components have a color prop set, to enable a migration of the default value. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/ensure-proper-xcss-usage/usage\\">ensure-proper-xcss-usage</a> | Enforces proper xcss usage: migrate from xcss() to cssMap() and use cssMap objects with specific keys. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/expand-motion-shorthand/usage\\">expand-motion-shorthand</a> | Expands `transition` and `animation` CSS shorthand properties into their individual sub-properties, so individual values can be replaced with motion tokens. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/icon-label/usage\\">icon-label</a> | Enforces accessible usage of icon labels when composed with Atlassian Design System components. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/lozenge-badge-tag-labelling-system-migration/usage\\">lozenge-badge-tag-labelling-system-migration</a> | Helps migrate Lozenge isBold prop, Badge appearance values, and SimpleTag/RemovableTag components as part of the Labelling System Phase 1 migration. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-banned-imports/usage\\">no-banned-imports</a> | Disallow importing banned modules. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-css-map-scoped/usage\\">no-css-map-scoped</a> | Disallows usage of the experimental `cssMapScoped` API from `@compiled/react`. This API is internal and is not part of the public Compiled CSS-in-JS interface. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-css-tagged-template-expression/usage\\">no-css-tagged-template-expression</a> | Disallows any `css` tagged template expressions that originate from Emotion, Styled Components or Compiled | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-dark-theme-vr-tests/usage\\">no-dark-theme-vr-tests</a> | Disallow using dark colorScheme in VR tests. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-deprecated-apis/usage\\">no-deprecated-apis</a> | Disallow using deprecated APIs. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-deprecated-design-token-usage/usage\\">no-deprecated-design-token-usage</a> | Disallow using deprecated design tokens. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-deprecated-imports/usage\\">no-deprecated-imports</a> | Disallow importing deprecated modules. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-direct-use-of-web-platform-drag-and-drop/usage\\">no-direct-use-of-web-platform-drag-and-drop</a> | Disallow using direct use of native drag and drop (please use Pragmatic drag and drop) | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-emotion-primitives/usage\\">no-emotion-primitives</a> | Ensures usage of Compiled Primitives import instead of Emotion entrypoint. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-empty-styled-expression/usage\\">no-empty-styled-expression</a> | Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements). | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-exported-css/usage\\">no-exported-css</a> | Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-exported-keyframes/usage\\">no-exported-keyframes</a> | Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-anchor/usage\\">no-html-anchor</a> | Discourage direct usage of HTML anchor elements in favor of Atlassian Design System link components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-button/usage\\">no-html-button</a> | Discourage direct usage of HTML button elements in favor of Atlassian Design System button components. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-checkbox/usage\\">no-html-checkbox</a> | Discourage direct usage of HTML checkbox elements in favor of the Atlassian Design System checkbox component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-code/usage\\">no-html-code</a> | Discourage direct usage of HTML code elements in favor of the Atlassian Design System code component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-heading/usage\\">no-html-heading</a> | Discourage direct usage of HTML heading elements in favor of Atlassian Design System heading components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-image/usage\\">no-html-image</a> | Discourage direct usage of HTML image elements in favor of the Atlassian Design System image component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-radio/usage\\">no-html-radio</a> | Discourage direct usage of HTML radio elements in favor of the Atlassian Design System radio component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-range/usage\\">no-html-range</a> | Discourage direct usage of HTML range elements in favor of the Atlassian Design System range component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-select/usage\\">no-html-select</a> | Discourage direct usage of HTML select elements in favor of the Atlassian Design System select component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-text-input/usage\\">no-html-text-input</a> | Discourage direct usage of HTML text input elements in favor of the Atlassian Design System textfield component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-html-textarea/usage\\">no-html-textarea</a> | Discourage direct usage of HTML textarea elements in favor of the Atlassian Design System textarea component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-icon-spacing-prop/usage\\">no-icon-spacing-prop</a> | Disallows usage of the deprecated spacing prop on new icons. Use Flex with cssMap for spacing instead. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/no-invalid-css-map/usage\\">no-invalid-css-map</a> | Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript\'s type-checking. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-keyframes-tagged-template-expression/usage\\">no-keyframes-tagged-template-expression</a> | Disallows any `keyframe` tagged template expressions that originate from Emotion, Styled Components or Compiled | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-margin/usage\\">no-margin</a> | Disallow using the margin CSS property. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-modal-label/usage\\">no-modal-label</a> | Disallows usage of the `label` prop on Atlassian Design System modal dialog and modal entry-point triggers. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-nested-styles/usage\\">no-nested-styles</a> | Disallows use of nested styles in `css` functions. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-physical-properties/usage\\">no-physical-properties</a> | Disallow physical properties and values in `css` and `cssMap` function calls. | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-placeholder/usage\\">no-placeholder</a> | Placeholders should not be used. If information should be given to the user about the proper type or formatting of a value, this should be included using a helper message that is associated to the input instead. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-readonly-or-disabled-inputs/usage\\">no-readonly-or-disabled-inputs</a> | Inputs should almost always be interactive. Disabled and read-only inputs can usually be replaced by a more user-friendly design pattern. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-separator-with-list-elements/usage\\">no-separator-with-list-elements</a> | Warn when the `separator` prop is used with `as=\\"li\\"`, `as=\\"ol\\"`, or `as=\\"dl\\"` in the Inline component. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-styled-tagged-template-expression/usage\\">no-styled-tagged-template-expression</a> | Disallows any `styled` tagged template expressions that originate from Emotion, Styled Components or Compiled | | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-to-match-snapshot/usage\\">no-to-match-snapshot</a> | Disallow using toMatchSnapshot() in favor of toMatchInlineSnapshot(). See https://hello.atlassian.net/wiki/spaces/DST/pages/6105892000/DSTRFC-038+-+Removal+of+.toMatchSnapshot for rationale. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsafe-design-token-usage/usage\\">no-unsafe-design-token-usage</a> | Enforces design token usage is statically and locally analyzable. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsafe-inline-snapshot/usage\\">no-unsafe-inline-snapshot</a> | Enforce guardrails on toMatchInlineSnapshot usage: snapshots must not exceed 100 lines and must not contain internal implementation details like className or style attributes. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsafe-style-overrides/usage\\">no-unsafe-style-overrides</a> | Discourage usage of unsafe style overrides used against the Atlassian Design System. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unsupported-drag-and-drop-libraries/usage\\">no-unsupported-drag-and-drop-libraries</a> | Disallow importing unsupported drag and drop modules. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/no-unused-css-map/usage\\">no-unused-css-map</a> | Detects unused styles in cssMap objects to help keep code clean. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/prefer-primitives/usage\\">prefer-primitives</a> | Increase awareness of primitive components via code hints. Strictly used for education purposes and discoverability. | | | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-button-group-label/usage\\">use-button-group-label</a> | Ensures button groups are described to assistive technology by a direct label or by another element. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-character-counter-field/usage\\">use-character-counter-field</a> | Suggests using CharacterCounterField or CharacterCounter when Textfield or Textarea components have maxLength or minLength props. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-correct-field/usage\\">use-correct-field</a> | Ensure makers use appropriate field component for their respective form elements. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-cx-function-in-xcss/usage\\">use-cx-function-in-xcss</a> | Enforces cx function use to combine styles in xcss. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-datetime-picker-calendar-button/usage\\">use-datetime-picker-calendar-button</a> | Encourages makers to use calendar button in Atlassian Design System\'s date picker and datetime picker components. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-drawer-label/usage\\">use-drawer-label</a> | Encourages to provide accessible name for Atlassian Design System Drawer component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-field-message-wrapper/usage\\">use-field-message-wrapper</a> | Encourage use of message wrapper component when using form message components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-heading/usage\\">use-heading</a> | Encourage the usage of heading components. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-heading-level-in-section-message/usage\\">use-heading-level-in-section-message</a> | The `SectionMessage` component in `@atlaskit/section-message` needs to be the correct level within the document flow. This is not something that can be automated and requires contextual knowledge of what is present in the experience. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-heading-level-in-spotlight-card/usage\\">use-heading-level-in-spotlight-card</a> | Inform developers of eventual requirement of `headingLevel` prop in `SpotlightCard` component. The heading level should be the appropriate level according to the surrounding context. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-href-in-link-item/usage\\">use-href-in-link-item</a> | Inform developers of eventual requirement of `href` prop in `LinkItem` component. Elements with a `link` role require an `href` attribute for users to properly navigate, particularly those using assistive technologies. If no valid `href` is required for your use case, consider using a `ButtonItem` instead. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-latest-xcss-syntax/usage\\">use-latest-xcss-syntax</a> | Enforces usage of space design tokens rather than hard-coded values in xcss. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-latest-xcss-syntax-typography/usage\\">use-latest-xcss-syntax-typography</a> | Prohibits use of unsafe styling properties in xcss. Please use Text/Heading primitives instead. | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-menu-section-title/usage\\">use-menu-section-title</a> | Encourages makers to provide accessible title for Atlassian Design System Menu Section component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-modal-dialog-close-button/usage\\">use-modal-dialog-close-button</a> | Encourages makers to use close button in Atlassian Design System\'s modal dialog component. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-modal-title/usage\\">use-modal-title</a> | Encourages makers to include `ModalTitle` within `ModalHeader` when using Atlassian Design System modal dialog. | Yes | | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-onboarding-spotlight-label/usage\\">use-onboarding-spotlight-label</a> | Ensures onboarding spotlight dialogs are described to assistive technology by a direct label or by another element. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-popup-label/usage\\">use-popup-label</a> | Encourages to provide accessible name for Atlassian Design System Popup component. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-pressable-motion/usage\\">use-pressable-motion</a> | Suggests semantic motion tokens when Pressable or native buttons change interactive colours through local static styles. | | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-primitives-text/usage\\">use-primitives-text</a> | Encourage the usage of text components. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-should-render-to-parent/usage\\">use-should-render-to-parent</a> | Encourages makers to use the `shouldRenderToParent` where possible in Atlassian Design System `Popup` and `DropdownMenu` components. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-simple-field/usage\\">use-simple-field</a> | Encourage use of simple field for better developer experience and accessibility. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-simple-form/usage\\">use-simple-form</a> | Encourage use of simple form for better developer experience and accessibility. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-spotlight-package/usage\\">use-spotlight-package</a> | Discourage the use of @atlaskit/onboarding in favor of @atlaskit/spotlight. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tag-group-label/usage\\">use-tag-group-label</a> | Ensures tag groups are described to assistive technology by a direct label or by another element. | Yes | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-textfield-autocomplete/usage\\">use-textfield-autocomplete</a> | Enforce that Textfield components with type=\\"email\\", \\"tel\\", or \\"url\\" have an appropriate autocomplete value for WCAG 2.2 SC 1.3.5 compliance (Identify Input Purpose). | Yes | Yes | |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-motion/usage\\">use-tokens-motion</a> | Enforces usage of motion design tokens rather than hard-coded duration and easing values. | | | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-shape/usage\\">use-tokens-shape</a> | Enforces usage of shape design tokens rather than hard-coded values. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-space/usage\\">use-tokens-space</a> | Enforces usage of space design tokens rather than hard-coded values. | | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-tokens-typography/usage\\">use-tokens-typography</a> | Enforces usage of design tokens for typography properties rather than hard-coded values. | Yes | Yes | Yes |\\n| <a href=\\"/components/eslint-plugin-design-system/use-visually-hidden/usage\\">use-visually-hidden</a> | Enforce usage of the visually hidden component. | Yes | Yes | |\\n\\n<!-- END_RULE_TABLE_CODEGEN -->\\n\\n\\n## Props\\n\\nUse the recommended config to get reasonable defaults recommended by the Atlassian Design System:\\n\\n```diff\\nmodule.exports = {\\n extends: [\\n+ \'plugin:@atlaskit/design-system/recommended\',\\n ],\\n};\\n```\\n\\nWe don\'t recommended maintaining your own configuration. If you do not use our config you will need\\nto specify individual rules and configuration. Add the plugin to your `eslint.config.cjs` file.\\n\\n```diff\\nmodule.exports = {\\n plugins: [\\n+ \'@atlaskit/design-system\',\\n ],\\n};\\n```\\n\\nEnable the rules that you would like to use.\\n\\n```diff\\nmodule.exports = {\\n rules: [\\n+ \'@atlaskit/design-system/no-deprecated-apis\': \'error\',\\n ],\\n};\\n```\\n"}',
|
|
59
59
|
ruleName: 'index',
|
|
60
60
|
description: '---'
|
|
61
61
|
}, {
|
|
@@ -183,7 +183,7 @@ var lintRulesMcpStructuredContent = exports.lintRulesMcpStructuredContent = [{
|
|
|
183
183
|
ruleName: 'no-margin',
|
|
184
184
|
description: "Using margins to define spacing results in components that can't be readily reused in other contexts"
|
|
185
185
|
}, {
|
|
186
|
-
content: '{"ruleName":"no-modal-label","description":"Do not use the `label` prop on the Atlassian Design System modal dialog default import.","content":"# no-modal-label\\n\\nDo not use the `label` prop on the Atlassian Design System modal dialog default import.\\n\\nUse `ModalTitle` within `ModalHeader`, or another element with `titleId` applied from `useModal()`\\nto provide a clear, visible title for modal content. This content will be propagated to assistive\\ntechnology as well as serving visual users. It is very rare that a dialog title should differ\\nbetween the visible text and that shown to users of assistive technology.\\n\\n## Examples\\n\\nThis rule warns when `label` is used on the default import from `@atlaskit/modal-dialog` or
|
|
186
|
+
content: '{"ruleName":"no-modal-label","description":"Do not use the `label` prop on the Atlassian Design System modal dialog default import.","content":"# no-modal-label\\n\\nDo not use the `label` prop on the Atlassian Design System modal dialog default import.\\n\\nUse `ModalTitle` within `ModalHeader`, or another element with `titleId` applied from `useModal()`\\nto provide a clear, visible title for modal content. This content will be propagated to assistive\\ntechnology as well as serving visual users. It is very rare that a dialog title should differ\\nbetween the visible text and that shown to users of assistive technology.\\n\\n## Examples\\n\\nThis rule warns when `label` is used on:\\n\\n- the default import from `@atlaskit/modal-dialog` or `@atlaskit/modal-dialog/modal-dialog`\\n- `modalProps.label` on modal entry-point triggers from `@atlassian/entry-points`\\n\\n### Incorrect\\n\\n```tsx\\nimport ModalDialog from \'@atlaskit/modal-dialog\';\\n\\n<ModalDialog label=\\"Create issue\\" />;\\n```\\n\\n```tsx\\nimport Modal from \'@atlaskit/modal-dialog/modal-dialog\';\\n\\n<Modal label={modalLabel} />;\\n```\\n\\n```tsx\\nimport { ModalTrigger } from \'@atlassian/entry-points/modal-trigger\';\\n\\n<ModalTrigger entryPoint={entryPoint} modalProps={{ label: \'Create issue\' }}>\\n\\t{({ ref }) => <button ref={ref}>Open</button>}\\n</ModalTrigger>;\\n```\\n\\n### Correct\\n\\n```tsx\\nimport ModalDialog, { ModalHeader, ModalTitle } from \'@atlaskit/modal-dialog\';\\n\\n<ModalDialog>\\n\\t<ModalHeader>\\n\\t\\t<ModalTitle>Create issue</ModalTitle>\\n\\t</ModalHeader>\\n</ModalDialog>;\\n```\\n\\n```tsx\\nimport ModalDialog, { ModalHeader, ModalTitle, useModal } from \'@atlaskit/modal-dialog\';\\nimport Heading from \'@atlaskit/heading\';\\n\\nconst CustomHeader = () => {\\n\\tconst { titleId } = useModal();\\n\\n\\treturn (\\n\\t\\t<ModalHeader>\\n\\t\\t\\t<Heading id={titleId}>Create issue</Heading>\\n\\t\\t</ModalHeader>\\n\\t);\\n};\\n\\n<ModalDialog>\\n\\t<CustomHeader />\\n</ModalDialog>;\\n```\\n\\n```tsx\\nimport { ModalIconButtonTrigger } from \'@atlassian/entry-points/modal-icon-button-trigger\';\\n\\n// Top-level `label` on icon button triggers is the trigger button name — allowed.\\n<ModalIconButtonTrigger entryPoint={entryPoint} label=\\"Create issue\\" icon={AddIcon} />;\\n```\\n"}',
|
|
187
187
|
ruleName: 'no-modal-label',
|
|
188
188
|
description: 'Do not use the `label` prop on the Atlassian Design System modal dialog default import.'
|
|
189
189
|
}, {
|
|
@@ -10,7 +10,7 @@ var _searchTokensInputSchema = require("./search-tokens-input-schema");
|
|
|
10
10
|
|
|
11
11
|
var listSearchTokensTool = exports.listSearchTokensTool = {
|
|
12
12
|
name: 'ads_search_tokens',
|
|
13
|
-
description: "Searches Atlassian Design System **design tokens** from bundled metadata. Returns JSON objects with **name** and **exampleValue** for each match (search also considers description, usage guidelines, and CSS property hints in metadata).\n\nWHEN TO USE:\n**Styling or theming in code**\u2014you need the right `token('\u2026')` names for colors, space, typography, etc. Use during layout and visual work when tokens must match ADS. Prefer `ads_plan` when you also need icons and components in the same step.\n\nExample:\n```tsx\nimport { token } from '@atlaskit/tokens';\nconst styles = css({ color: token('color.text'), padding: token('space.100') });\n```",
|
|
13
|
+
description: "Searches Atlassian Design System **design tokens** from bundled metadata. Returns compact JSON objects with **name** and **exampleValue** for each match by default (search also considers description, usage guidelines, and CSS property hints in metadata). Set **includeMetadata** to include usage guidelines in each result.\n\nWHEN TO USE:\n**Styling or theming in code**\u2014you need the right `token('\u2026')` names for colors, space, typography, etc. Use during layout and visual work when tokens must match ADS. Prefer `ads_plan` when you also need icons and components in the same step.\n\nExample:\n```tsx\nimport { token } from '@atlaskit/tokens';\nconst styles = css({ color: token('color.text'), padding: token('space.100') });\n```",
|
|
14
14
|
annotations: {
|
|
15
15
|
title: 'Search ADS tokens',
|
|
16
16
|
readOnlyHint: true,
|
|
@@ -9,5 +9,6 @@ var _zod = require("zod");
|
|
|
9
9
|
|
|
10
10
|
var searchTokensInputSchema = exports.searchTokensInputSchema = _zod.z.object({
|
|
11
11
|
terms: _zod.z.array(_zod.z.string()).describe('Required: one or more terms; fuzzy match on token **name**, **description**, **exampleValue**, **usageGuidelines.usage**, and **usageGuidelines.cssProperties**. Example: `["spacing", "color.text", "background"]`.'),
|
|
12
|
-
limit: _zod.z.number().default(2).describe('Max matches **per term** (default 2).').optional()
|
|
12
|
+
limit: _zod.z.number().default(2).describe('Max matches **per term** (default 2).').optional(),
|
|
13
|
+
includeMetadata: _zod.z.boolean().default(false).describe('Include usage guidelines in each result (default false).').optional()
|
|
13
14
|
});
|